<paramref> (Visual Basic)
WORD をパラメーターとしてフォーマットします。
<paramref name="name"/>
パラメーター
- name
参照するパラメーターの名前。名前は、二重引用符 (" ") で囲みます。
解説
<paramref> タグを使用すると、WORD をパラメーターとして指定できます。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