すべてのプログラマーは、自分のコードを理解しやすくしようと努めますが、追加の説明が必要になることもあります。そうした場合、プログラマーはソースコード内に コメント を残します。コメントはコンパイラには無視されますが、ソースコードを読む人にとっては役立つことがあります。

簡単なコメントを以下に示します。

#![allow(unused)]
fn main() {
// こんにちは、世界
}

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

#![allow(unused)]
fn main() {
// ここでは複雑なことをしているため、その説明には十分な長さがあり、
// そのために複数行のコメントが必要です！ ふう！ このコメントが
// 何が起こっているのかを説明してくれるといいのですが。
}

コメントは、コードを含む行の末尾に置くこともできます。

ファイル名: src/main.rs

fn main() {
    let lucky_number = 7; // I'm feeling lucky today
}

ただし、よりよく見かけるのは、コメントを注釈対象のコードの上の別行に置く、この形式です。

ファイル名: src/main.rs

fn main() {
    // I'm feeling lucky today
    let lucky_number = 7;
}

Rust には、もう 1 種類のコメントであるドキュメンテーションコメントもあります。これについては、第 14 章の「Crate を Crates.io に公開する」の節で説明します。

Keyboard shortcuts

コメント