JetBrains Rider 2026.1 Help

Doxygen のドキュメント

Doxygen(英語)-style コメントはソースコード全体に配置でき、さまざまな形式で本格的なドキュメントを生成するために使用できます。

JetBrains Rider は doxygen からの情報を クイックドキュメント ポップアップ Ctrl+Q に組み込みます:

クイックドキュメントの Doxygen コメント

doxygen ドキュメントの表示

ドキュメントコメントからの情報は型情報に加えて クイックドキュメント ポップアップに含まれています。 ドキュメントポップアップを呼び出すには

  1. doxygen コメントの目的のシンボルにキャレットを置きます。

  2. Ctrl+Q を押します。

あるいは、チェックボックス ホバー時にクイックドキュメントを表示する (ファイル | 設定 | エディター | コード編集) が選択されている場合は、マウスポインターを目的のシンボルの上に移動するだけです。

関数パラメーターが関数の説明とは別にドキュメント化されている場合、JetBrains Rider はすべてのコメントをマージし、関数の完全なシグネチャードキュメントを表示します(doxygen が出力を生成する場合と同じ方法です)。

doxygen コメントの作成

doxygen コメントを最初から作成するには:

  1. 次のいずれかのシンボルを入力して: /////!/** または /*! を入力し、 Enter を押します。

  2. ドキュメントのテキストを記入するためのスタブが表示されます:

    コメントの生成

文書エンティティ コンテキストアクションを使用することもできます。 必要に応じて、JetBrains Rider が生成に使用する docライブテンプレートを 編集してコメントスタブをカスタマイズできます。

信頼できる名前変更

関数またはそのパラメーターの名前を変更している間、ドキュメントのコメントはそれに応じて更新する必要があります。 Renameリファクタリング Shift+F6 の場合、JetBrains Rider は他の参照とともにドキュメントコメントを更新します。

前:

名前変更の例 - 前

後:

名前変更の例 - 後

Doxygen コメントの色

doxygen コメントで使用される色を構成するには、 設定 | エディター | カラースキームの切り替え | C/C++ に移動し、 コメント | Doxygen ノードを開きます。

Doxygen コメントの色
2026 年 6 月 12 日