106

Visual Studioで自動生成関数ヘッダーを作成する方法（できればキーボードショートカット）があるかどうか疑問に思いました。

例：

Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

そして、それは自動的にこのようなものになるでしょう...


'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
4

8 に答える 8

177

その「3つの単一コメントマーカー」を作成します

C# では///

これはデフォルトで吐き出します：

/// <summary>
/// 
/// </summary>
/// <returns></returns>

VS テンプレートの編集に関するヒントをいくつか紹介します。

于 2009-01-09T21:21:05.570 に答える
51

ゴーストドック！

関数を右クリックし、[これをドキュメント化] を選択して、

private bool FindTheFoo(int numberOfFoos)

になる

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

(はい、すべて自動生成されます)。

C#、VB.NET、および C/C++ をサポートしています。Ctrlデフォルトでは++にマッピングされていShiftますD。

注意: メソッド シグネチャ以外の情報をドキュメントに追加する必要があります。自動生成されたドキュメントだけにとどまらないでください。このようなツールの価値は、メソッド シグネチャから抽出できるドキュメントを自動的に生成することです。そのため、追加する情報はすべて新しい情報である必要があります。

そうは言っても、私は個人的にはメソッドが完全に自己文書化されている方が好きですが、コーディング標準が外部の文書化を義務付けている場合もあります。

于 2009-01-09T21:26:04.267 に答える
19

Visual Assist にも優れたソリューションがあり、非常にカスタマイズ可能です。

doxygen スタイルのコメントを生成するように微調整した後、これらの 2 回のクリックで生成されるのは -

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

（デフォルト設定では、少し異なります。）

編集: 「ドキュメント メソッド」テキストをカスタマイズする方法は、VassistX -> Visual Assist オプション -> 提案の下にあり、「VA スニペットの編集」、言語: C++、タイプ: リファクタリングを選択し、「ドキュメント メソッド」に移動してカスタマイズします。上記の例は、次のように生成されます。

va_doxy

于 2009-05-01T19:02:58.337 に答える
14

通常、コメントしたいもの (メソッド、クラス) の上に単一のコメント マーカーを 3 つ追加すると、Visual Studio によって自動的に作成されます。

C# では、これは///.

Visual Studio がこれを行わない場合は、で有効にすることができます。

オプション -> テキスト エディター -> C# -> 詳細設定

そしてチェック

/// の XML ドキュメント コメントを生成する

写真の説明

于 2016-01-04T08:41:32.027 に答える
4

Visual Basicでは、最初に関数/サブを作成し、その上の行に'を3回入力すると、ドキュメントに関連するxmlが自動生成されます。これは、インテリセンスでマウスオーバーしたとき、および関数を使用しているときにも表示されます。

于 2012-07-17T19:50:42.177 に答える
2

コード スニペットを使用して、必要な行を挿入できます。

また、関数ヘッダーの上の行に単一引用符 (''') を 3 つ入力すると、入力可能な XML ヘッダー テンプレートが挿入されます。

これらの XML コメントはドキュメンテーション ソフトウェアで解釈でき、ビルド出力に assembly.xml ファイルとして含まれます。その XML ファイルを DLL と共に保持し、その DLL を別のプロジェクトで参照すると、それらのコメントが IntelliSense で使用できるようになります。

于 2009-01-09T19:59:50.463 に答える
-1

私は、ファイルを保存するときに単語を分析して適切なドキュメント出力を自動的に生成するTodocというオープンソースプロジェクトに取り組んでいます。それは既存のコメントを尊重し、本当に速くて流動的です。

http://todoc.codeplex.com/

于 2012-04-21T01:27:20.857 に答える