Visual Studioで関数ドキュメントを自動生成する

https://stackoverflow.com/questions/429452

06-07-2019
|

質問

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)

解決

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

C＃では ///

です

デフォルトで吐き出されるもの：

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

VSテンプレートの編集に関するヒント。

他のヒント

GhostDoc ！

関数を右クリックして、「これを文書化」を選択します。そして

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 にマッピングされます。

覚えておいてください：メソッドの署名以外の情報をドキュメントに追加する必要があります。自動生成されたドキュメントだけで停止しないでください。このようなツールの価値は、メソッドシグネチャから抽出できるドキュメントを自動的に生成することです。したがって、追加する情報はすべて new 情報でなければなりません。

そうは言っても、私はメソッドが完全に自己文書化されることを個人的に好みますが、時には外部の文書化を義務付けるコーディング標準があり、このようなツールはあなたの頭を悩ますタイピングを節約します。

///

は、メソッドの説明のコメントブロックを取得するためのショートカットです。ただし、追加する前に、関数名と署名を記述したことを確認してください。最初に関数名と署名を書きます。

次に、関数名の上に///

と入力します

そして自動的に取得します

Visual Assistには素敵なソリューションもあり、非常にコスト効率が高くなっています。

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

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

}

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

編集：「ドキュメントメソッド」テキストをカスタマイズする方法は、VassistX-＆gt; Visual Assist Options-＆gt; Suggestionsの下にあり、「VAスニペットの編集」、言語：C ++、タイプ：リファクタリングを選択し、「ドキュメントメソッド」に移動してカスタマイズします。上記の例は以下によって生成されます：