Rustコメント

Rustのコメント方法は他の言語(C、Java)と同じで、2つのコメント方法をサポートしています:

実例

// これは最初のコメント方法です

/* これは2番目のコメント方法です */

/*
* 複数行コメント
* 複数行コメント
* 複数行コメント
 */

ドキュメント説明用のコメント

Rustで使用すると//その後に最初の改行までの内容をコメントにすることができます。

このルールでは、3つのスラッシュは///依然として有効なコメントの開始です。したがってRustでは///をドキュメント説明コメントの先頭として使用できます:

実例

/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let x = add(1, 2);
///
/// ```

fn add(a: i32, b: i32) -> i32 {
    return a + b;
}
   
fn main() {
    println!("{}",add(2,3));
}

プログラム内の関数 add には、優雅なコメントが付けられ、IDEに表示できます:

Tip:Cargoには cargo doc 機能があり、開発者はこのコマンドを使用して、プロジェクト内の説明コメントをHTML形式の説明ドキュメントに変換できます。

その他の拡張