Rust のコメントの種類とドキュメント

Beginner

This tutorial is from open-source community. Access the source code

はじめに

この実験では、Rust でサポートされているさまざまな種類のコメント、つまり通常のコメントとドキュメントコメントについて学びます。通常のコメントは、2 つのスラッシュから始まり行末まで続く行コメント、または /**/ で囲まれネスト可能なブロックコメントになります。一方、ドキュメントコメントは HTML ライブラリドキュメントを生成するために使用され、 /// または //! から始まります。

注: 実験でファイル名が指定されていない場合、好きなファイル名を使用できます。たとえば、 main.rs を使用して、 rustc main.rs &&./main でコンパイルして実行できます。

コメント

どのプログラムもコメントが必要で、Rust はいくつかの異なる種類をサポートしています。

  • コンパイラによって無視される 通常のコメント:
    • // 行末まで続く行コメント。
    • /* 終了区切り文字まで続くブロックコメント。 */
  • HTML ライブラリドキュメントに解析される ドキュメントコメント:
    • /// 次の項目のライブラリドキュメントを生成します。
    • //! 囲まれた項目のライブラリドキュメントを生成します。
fn main() {
    // これは行コメントの例です。
    // 行の先頭に 2 つのスラッシュがあります。
    // これ以降に書かれたものはコンパイラによって読み取られません。

    // println!("Hello, world!");

    // 実行してみてください。分かりましたか?では、2 つのスラッシュを削除して再度実行してみてください。

    /*
     * これはもう 1 つのコメントの種類、ブロックコメントです。一般的には、
     * 行コメントが推奨されるコメントスタイルです。ただし、ブロックコメントは
     * 一時的にコードのチャンクを無効にする際に非常に便利です。
     * /* ブロックコメントは /* ネストできます、 */ */ なので、このmain()関数内のすべてをコメントアウトするには数回のキー入力だけで済みます。
     * /*/*/* 自分で試してみてください! */*/*/
     */

    /*
    注:前の列の `*` は全くスタイルのためのものです。実際に必要なものではありません。
    */

    // ブロックコメントを使うと、行コメントよりも式を操作しやすくなります。
    // コメント区切り文字を削除して結果を変更してみてください:
    let x = 5 + /* 90 + */ 5;
    println!("`x` は 10 か 100 か?x = {}", x);
}

まとめ

おめでとうございます!あなたはコメントの実験を完了しました。あなたのスキルを向上させるために、LabEx でさらに多くの実験を行って練習してください。