質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.53%

  • C++

    3443questions

    C++はC言語をもとにしてつくられた最もよく使われるマルチパラダイムプログラミング言語の1つです。オブジェクト指向、ジェネリック、命令型など広く対応しており、多目的に使用されています。

C++で///を使ったコメント

解決済

回答 6

投稿

  • 評価
  • クリップ 0
  • VIEW 3,255

yaeyama

score 47

C++関係ないのかもしれませんが、最近コメント文で///とスラッシュを三つ使ったものをよく見ます。
VS2015で///を使うと//や/**/より濃い緑色になるのにも最近気が付きました。

そこで質問なのですが、///ってどういうときに使うものなのでしょうか?
なにか特別なことをコメントに残すときに使うのでしょうか?

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 6

+6

メソッドや変数の上にC++やC#では「///」VBでは「'''」といったコメントアウトをすると、自動で残りのテキストをVisualStadioが表示してくれます。

/// <summary>
/// 名前
/// </summary>
/// <param name="hoge">変数名</param>
/// <returns>備考</returns>
public void test(int hoge)

といったコメントですが、別の場所でこれを呼び出してカーソルを合わせるとこの内容が吹き出しに出てくるため、説明文に使えます

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/03/23 17:16

    回答ありがとうございます。
    param name="hoge"と
    int hogeが対応してるのですね。
    わざわざコードまでありがとうございます。

    キャンセル

  • 2017/03/23 20:54

    C++で自動で補完されますか?プロジェクトテンプレートでは見かけますが、Intellisenseは対応していない気がします。

    キャンセル

  • 2017/03/23 21:28

    hmmmさん
    https://jyn.jp/visualstudio-cpp-xml-document/
    拡張機能を追加すると補完できるみたいですね。

    キャンセル

  • 2017/03/23 21:54

    @yaeyama さん。ありがとうございます。できました。

    キャンセル

+3

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/03/23 17:11

    回答ありがとうございます。
    ドキュメントコメントについては理解できました。

    しかし、自分が目にした///を使ったコメント文ではXMLは使われておらず、
    普通に関数の説明のような一行のコメントで使われていました。
    この場合はどういった意味になるのでしょうか?

    それとも、必ずしもXMLを使わなければならないということではないということでしょうか?
    仮にそうだとすると、//や/**/との違いがわかりません。

    キャンセル

+3

念の為に言うときますが、/// だとどうこうってのは言語仕様で規定されているものではなく、
あくまで Visual Studio/Visual C++ の独自機能。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/03/23 17:12

    回答ありがとうございます。
    なるほど、Visual Studioの機能なのですね。

    キャンセル

+1

/// はXMLドキュメントを生成するための書き方です。そのソースコードを元に作成できるようです。私は利用したことはないですが。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

checkベストアンサー

0

既にVisualStudioに関して話が出ていますが、似たようなツールで昔からDoxygenというソフトウェアがあります。

例えば、lenyaさんのサンプルをお借りして、Doxygen風に書くと、

/// @brief 概要
/// @param[in] hoge 変数の意味
/// @return 戻り値の説明
public void test(int hoge) 

のようになります。
もしくは簡単に、

/// 概要
public void test(int hoge)

なんて書き方もあります。
また、doxygenはある程度書き方があって、「@brief」が「\brief」だったり、「///」が「//!」だったりします。

こんな感じでコメントを書いておけば、doxygenでこんな感じのドキュメントを生成する事ができます。

doxygenはオープンソースで、マルチプラットフォームで動作するので、オープンソースプロジェクトや、VisualStudioを使わない開発環境でのプロジェクトでは、よく見るコメントの書き方ですね。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/03/23 22:51 編集

    回答ありがとうございます。
    /// @brief 概要
    /// @param[in] hoge 変数の意味
    /// @return 戻り値の説明
    public void test(int hoge)
    この書き方も同じプロジェクト内に見られたのでおそらくdoxygenの書き方で間違いないと思います。
    doxygen初めて聞きましたけど便利そうですね。

    キャンセル

0

言語の文法上に違いはありません。

エディタや開発環境の機能によって画面表示が変わるだけです。1つの空白と10個の連続した空白の違いみたいなものです。(文法上に違いはないが、画面表示は変わる)

開発環境によっては補完機能やドキュメント生成ツールを持っているので、こちらの関係で差分が出る可能性もあります。もちろん、コンパイル結果(得られる実行ファイル)が変わるものではありません。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.53%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

  • C++

    3443questions

    C++はC言語をもとにしてつくられた最もよく使われるマルチパラダイムプログラミング言語の1つです。オブジェクト指向、ジェネリック、命令型など広く対応しており、多目的に使用されています。