ReSharper 2026.1 Help

Doxygen のドキュメント

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

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

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

doxygen ドキュメントの表示

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

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

  2. Control+Q を押します。

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

doxygen コメントの作成

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

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

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

    コメントの生成

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

信頼できる名前変更

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

Before:

名前変更の例 - 前

以降:

名前変更の例 - 後
2026 年 6 月 12 日