English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية

Rust コメント

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

// これは第1種のコメント方法です
/* これは第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 で表示できます:

ヒント:Cargo には cargo doc 機能があり、開発者はこのコマンドを使用して、プロジェクトの説明コメントを HTML フォーマットの説明文書に変換できます。