<param> (Visual Basic)

  • [アーティクル]

パラメーターの名前と説明を定義します。

<param name="name">description</param>

パラメーター

  • name
    メソッド パラメーターの名前。 名前は、二重引用符 (" ") で囲みます。

  • description
    パラメーターの説明。

解説

<param> タグは、メソッド宣言のコメント内で使用して、メソッドのパラメーターの 1 つを説明します。

<param> タグのテキストは、[パラメーター ヒント] および オブジェクト ブラウザー に表示されます。

コンパイル時に /doc を指定すると、ドキュメント コメントをファイルに出力できます。

使用例

<param> タグを使って id パラメーターの説明を記述する例を次に示します。

''' <param name="id">The ID of the record to update.</param>
''' <remarks>Updates the record <paramref name="id"/>.
''' <para>Use <see cref="DoesRecordExist"/> to verify that
''' the record exists before calling this method.</para>
''' </remarks>
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here.
End Sub
''' <param name="id">The ID of the record to check.</param>
''' <returns><c>True</c> if <paramref name="id"/> exists,
''' <c>False</c> otherwise.</returns>
''' <remarks><seealso cref="UpdateRecord"/></remarks>
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
    ' Code goes here.
End Function

参照

参照

ドキュメント コメントとして推奨される XML タグ (Visual Basic)