#10 Rustで学ぶコメント規約の基本

7月 30, 2026

Rustのコメントには、他の言語と共通する書き方に加えて、ドキュメントを自動生成できる特別なコメントが用意されています。この記事では、Rustにおけるコメントの書き方と、Rustコミュニティの文化を解説します。

コメントの書き方

1行コメントは//を使います。

// これは年齢を表す変数
let age = 20;

複数行にまたがるコメントには/* */も使えますが、Rustでは各行に//を付ける書き方の方が一般的です。

ドキュメントコメントという特別な書き方

Rustには///から始める「ドキュメントコメント」という特別な書き方があります。

/// 利用者に挨拶を表示する関数
///
/// # 引数
/// * `name` - 利用者の名前
fn greet(name: &str) {
    println!("こんにちは、{}さん", name);
}

このコメントは、cargo docというコマンドを使うことで、Webページ形式の説明書きとして自動的に生成できます。# 引数のようにMarkdown形式の見出しを使えるのも特徴で、生成されたドキュメントでは整形された見出しとして表示されます。

サンプルコードがテストにもなる

ドキュメントコメントの中にサンプルコードを書いておくと、cargo testを実行したときに、そのサンプルコードが実際に動くかどうかまで自動でチェックしてくれます。

/// 2つの数を足す
///
/// # Examples
/// ```
/// let result = my_crate::add(2, 3);
/// assert_eq!(result, 5);
/// ```
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

この仕組みは「ドクテスト」と呼ばれ、説明とテストが古くなって食い違ってしまう(ドキュメントは残っているが実際の動作と合っていない)問題を防いでくれます。

何を書くべきか

Rustのコミュニティでは、公開する関数には必ずドキュメントコメントを書く文化が根付いています。関数の使い方だけでなく、簡単なサンプルコードを一緒に載せることも推奨されています。

Rustならではの注意点

//(通常のコメント)と///(ドキュメントコメント)は、見た目が非常に似ていますが役割が異なります。ドキュメントとして残したい説明には、必ずスラッシュを3つ使うようにしましょう。

まとめ

Rustのコメントは//が基本で、公開する関数には///によるドキュメントコメントを書く文化があります。cargo docで説明書きを生成でき、ドクテストによってサンプルコードの正確さも保てる点を覚えておきましょう。

本ページはプロモーションを含みます。

参考書籍(PR)

Rustをもっと学びたい方には「実践Rust入門[言語仕様から開発手法まで]」がおすすめです。

コードを書かずに自動化したい方へ

「学んだけど自分の作業に組み込む時間がない」という方向けに、ダブルクリックで動く Windows専用の自動化ツールをオーダーメイドで作成しています。気になる方はこちらをご覧ください。

このブログを検索

Toyoのプログラミング学習ブログ