コメント

プログラマは理解しやすいコードを書く努力をしますが、ときに追加の説明が必要です。このような場合、プログラマはソースコードにコメントを残します。コンパイラはコメントを無視しますが、ソースコードを読む人にとって役立つものになります。

コメントは2つのスラッシュ (//) から始まり、改行までをコメントとみなします。

examples/ch04-basic-syntax/src/comments.zen

test "comments" {
    //これはコメントです。

    //下の行はコメントで、実行されません。
    //ok(false);

    const x = true;  //行の末尾にコメントを書くことができます。
    ok(x);
}

Zenには複数行にわたるブロックコメントは存在しません（例えばＣ言語における /* */ コメント）。

ドキュメンテーションコメント

3つのスラッシュ（///）から始まるコメントは、ドキュメンテーションコメントと呼ばれ、特別なコメントとして扱われます。ドキュメンテーションコメントは、Zenのソースコードからドキュメントを自動生成する時に利用されます。

連続した複数のドキュメンテーションコメントはマージされ、複数行にまたがるドキュメンテーションコメントが形成されます。

examples/ch04-basic-syntax/src/comments.zen:14:29

/// 2次元座標を表す構造体です。複数行にわたる
/// ドキュメンテーションコメントは、このように書けます。
const Point = struct {
    /// x座標の位置です。これもドキュメンテーションコメントです
    x: u32,  // 0が原点です。これはドキュメンテーションコメントではありません。
    /// y座標の位置です。これもドキュメンテーションコメントです
    y: u32,

    /// 原点の値で初期化された値を返します。
    pub fn origin() Point {
        return Point {
            .x = 0,
            .y = 0,
        };
    }
};

Zen

ドキュメンテーションコメント

Chapter 1

Chapter 2

Chapter 3

Chapter 4

Chapter 5

Chapter 6

Chapter 7

Chapter 8

Chapter 9

Chapter 10

Chapter 11

Chapter 12

Chapter 13

Chapter 14

Chapter 15

Appendix

Error Explanation