<paramref> (Visual Basic)

単語をパラメーターとして書式設定します。

構文

<paramref name="name"/>  

パラメーター

name
参照するパラメーターの名前。 名前を二重引用符 (" ") で囲みます。

注釈

<paramref> タグを使用すると、単語がパラメーターであることを示す方法が提供されます。 XML ファイルを処理して、このパラメーターを別の方法で書式設定できます。

-doc を使用してコンパイルし、ドキュメントコメントをファイルに処理します。

例

この例では、 <paramref> タグを使用して、 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 コメント タグ