<paramref> (Visual Basic)

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

構文

<paramref name="name"/>  

パラメーター

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

Remarks

<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 のコメント用タグ