<remarks> (Visual Basic)

  • [アーティクル]

更新 : 2007 年 11 月

メンバの開設セクションを指定します。

<remarks>description</remarks>

パラメータ

  • description
    メンバの説明。

解説

<remarks> タグを使用して、型の情報を追加し、<summary> (Visual Basic) で指定された情報を補足します。この情報は オブジェクト ブラウザ に表示されます。

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

使用例

この例では、<remarks> タグを使用して UpdateRecord メソッドの機能について説明します。

''' <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)