Rust のコメントの説明と注釈

はじめに

コメントへようこそ。この実験は、Rust Bookの一部です。LabEx で Rust のスキルを練習することができます。

この実験では、Rust におけるコメントについて学び、ソースコードに説明や注釈を付けることで、より理解しやすくする方法を学びます。

Skills Graph

コメント

すべてのプログラマは、自分たちのコードを理解しやすくすることを目指していますが、時には追加の説明が必要になることもあります。このような場合、プログラマはソースコードに「コメント」を残します。これらのコメントはコンパイラが無視しますが、ソースコードを読む人にとっては便利な場合があります。

以下は、簡単なコメントです。

// hello, world

Rust では、慣用的なコメントスタイルは、コメントを 2 つのスラッシュで始め、コメントは行末まで続きます。1 行を超えるコメントの場合、各行に//を含める必要があります。例えば：

// ここでは複雑なことをしています。長さが長く、複数行のコメントが必要になりました！ふーん！うまくいけば、このコメントで何が起こっているのか説明できるでしょう。

コメントは、コードが記述されている行の末尾にも置くことができます。

ファイル名：src/main.rs

fn main() {
    let lucky_number = 7; // 今日はラッキーな気がする
}

しかし、コメントをコードの上の別の行に記述するこの形式で使うことがもっと頻繁に見られます。

ファイル名：src/main.rs

fn main() {
    // 今日はラッキーな気がする
    let lucky_number = 7;
}

Rust には、もう 1 種類のコメントであるドキュメントコメントもあります。これについては、「Publishing a Crate to Crates.io」で説明します。

まとめ

おめでとうございます！コメントの実験を完了しました。LabEx でさらに多くの実験を行って、スキルを向上させましょう。