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>関数を右クリックし、「これを文書化」を選択して、
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。
覚えておいてください。メソッドのシグネチャを超えた情報をドキュメントに追加する必要があります。自動生成されたドキュメントだけで停止するのではありません。このようなツールの価値は、メソッドシグネチャから抽出できるドキュメントを自動的に生成することです。そのため、追加する情報はすべて新しい情報である必要があります。
そうは言っても、私は個人的にメソッドが完全に自己文書化されている場合を好みますが、場合によっては、外部の文書化を義務付けるコーディング標準があり、このようなツールを使用すると、多くの頭の悪いタイピングを節約できます。
///
メソッド説明コメントブロックを取得するためのショートカットです。ただし、追加する前に、関数名とシグネチャを書き込んだことを確認してください。まず、関数名と署名を記述します。
次に、関数名の上に///と入力します
あなたはそれを自動的に取得します
Visual Assistにも優れたソリューションがあり、コストも非常に高くなります。
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」、言語：C ++、タイプ：Refactoringを選択し、「Document Method」に移動してカスタマイズします。上記の例は、以下によって生成されます。
ファイルを保存するときに、単語を分析して適切なドキュメント出力を自動的に生成するTodocというオープンソースプロジェクトに取り組んでいます。それは既存のコメントを尊重し、本当に速くて流動的です。
