ReSharper 2024.3 ヘルプ

Doxygen のドキュメント

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

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

Doxygen comments in Quick Documentation

doxygen ドキュメントの表示

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

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

  2. Control+Q を押します。

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

doxygen コメントの作成

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

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

  2. ドキュメントのテキストを記入するためのスタブがあります:

    Generate comments

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

信頼できる名前変更

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

次の前で改ページ:

Renaming example - before

次の後で改ページ:

Renaming example - after

関連ページ:

C/C++ の定義済みライブテンプレート

このトピックでは、ReSharper 2024.3 の C/C++ の事前定義されたライブテンプレートをすべてリストします。ライブテンプレートの詳細については、「ライブテンプレートを使用してソースコードを作成する」を参照してください。現在のファイルコンテキストどこでもスコープ本文 $CTX$ パラメーター - 現在のコンテキストを説明するアイテムのリストを提供します。これには、型名、名前空間名などを含むファイル名が含まれます。新しい GUID を挿入どこでもスコープ本文 $GUID$ パラメーター - 新し...

C++ のリファクタリング

リファクタリングを実行するシンボルにキャレットを置き、リファクタリングするコードフラグメントを選択するか、ツールウィンドウ内の項目を選択します。以下のいずれか 1 つを実行します: メインメニューからを選択し、目的のリファクタリングを選択します。このメニューで使用できるリファクタリングのリストは、現在のコンテキストによって異なります。ReSharper がコンテキストのリファクタリングを提案できない場合、メニュー全体が無効になります。エディター、ファイル構造ウィンドウ、またはその他の ReShar...

Clang-Tidy インテグレーション

Clang-Tidy は、一般的な Clang コンパイラーに基づいた強力なオープンソースコード解析ツールです。典型的なプログラミングエラーのための広範な一連のコードチェックとそれに伴う修正が付属しています。ReSharper は、Clang-Tidy とのシームレスな統合を提供します。これは、ファイルを編集すると、ReSharper が別のプロセスとしてバックグラウンドで Clang-Tidy を実行し、インスペクションの結果が他の ReSharper のインスペクションと一緒に表示されることを意...

Clang 形式の使用

C++ ファイル (および部分的に JavaScript および TypeScript ファイル) では、ReSharper は Clang 形式で定義されたフォーマットスタイルをサポートします。デフォルトでは、Clang-Format 構成ファイルは、フォーマットスタイル設定のソースとして自動的に使用されます。Clang フォーマットとは何ですか ? ReSharper はどのようにサポートしていますか ?:Clang-Format は、広く使用されている C++ コードフォーマッタです。YAM...