web-dev-qa-db-ja.com

関数と関数パラメーターに説明を追加する方法は？

私は大量のオーバーロードを持つVB.NET関数を書いています。ほとんどの.NET関数には、IntelliSenseにパラメーターの説明があることがわかりました。たとえば、String.Compare(、IntelliSenseはCompares two specified System.String objects and returns...あなたはアイデアを得る。この説明は変更され、同じ機能の異なるオーバーロードバージョンをクリックしてクリックします。パラメーターの入力を開始すると、現在入力中のパラメーターも説明されます。例：strA: The first string to compare.。

私の機能にそのような説明を与えるにはどうすればよいですか？

vb.netuser-defined-functions
39
Phonon

あなたがしなければならないのは、あなたの関数の前の行にある3つのアポストロフィです。 .NETが残りのコードを追加します。タグのインテリセンスに表示するテキストを挿入します。

''' <summary>
''' Returns the name of the code.
''' </summary>
Function GetName() As String
    Return "Something"
End Function
69
Jeff Stock

パラメータについて...

''' <summary>
''' Procedure description
''' </summary>
''' <param name="someVariable">someVariable description.</param>
''' <param name="someVariable">someVariable description.</param>
''' <remarks></remarks>
37
Jack

メソッド/メンバー名を右クリックし、コンテキストメニューから[コメントの挿入]を選択します。

メンバー/メソッドのXMLの内容は、Visual Studioの一部のバージョンのintellisenseヒントウィンドウ内に表示されます。

    ''' <summary>
    ''' Summary for the method goes here
    ''' </summary>
    ''' <param name="value">Param comments go here</param>
    ''' <remarks></remarks>
Private Sub SomeMethod(ByVal value As Decimal)
21
Smudge202

Xmlコメントを使用します。コンパイル後にインテリセンスにロードされる定義済みのタグがいくつかあります。すばらしいことは、関数の上の行にカーソルを置いてから、 '' '（それが理にかなっている場合は、単一引用符）を押して入力すると、たくさんのものが事前に入力されます。記事はこちら：

XMLコメントでコードを文書化する

7
rigamonk

メソッドの前の行にカーソルを置き、3つのアポストロフィ（'''）。メソッドとそのパラメーターのXMLドキュメントを作成するためのテンプレートを取得します。

3
Guffa