web-dev-qa-db-ja.com

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

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)
functionvisual-studio-2008headerauto-generate
83
Ryan M

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

C＃では///

これはデフォルトとして吐き出されます：

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

VSテンプレートの編集に関するいくつかのヒント

151
Michael Paulukonis

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情報である必要があることです。 。

そうは言っても、個人的にはメソッドが完全に自己文書化されることを好みますが、時には外部の文書化を義務付けるコーディング標準がある場合があり、このようなツールを使用することで頭を打ちます。

46
Rasmus Faber
///

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

次に、関数名の上に///と入力します

自動的に取得します

enter image description here

32
Bimzee

Visual Assistには Nice solution もあり、高度にコスト化可能です。

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

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

}

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

編集：「ドキュメントメソッド」テキストをカスタマイズする方法は、VassistX-> Visual Assist Options-> Suggestionsの下にあり、 'Edit VA Snippets'、Language：C++、Type：Refactoring、then go上記の例は、次の方法で生成されます。

va_doxy

17
Ofek Shilon

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

C＃では、これは///。

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

[オプション]-> [テキストエディター]-> [C＃]-> [詳細]

そしてチェック

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

pictured description

11
Domysee

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

3
Paul Ishak

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

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

これらのXMLコメントは、ドキュメントソフトウェアで解釈でき、Assembly.xmlファイルとしてビルド出力に含まれます。そのXMLファイルをDLLで保持し、別のプロジェクトでDLLを参照する場合、それらのコメントはintellisenseで利用可能になります。

2
DCNYAM

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

http://todoc.codeplex.com/

0
Mathias Lykkegaard Lorenzen