ホーム > >

Rust コメント

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

実例

// これがコメントの1種類です

/* これはもう1種類のコメントです */ 

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

ドキュメントを説明するために使用されるコメント

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形式の説明文書に変換できます。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です