<remarks> (Visual Basic)

メンバーの解説セクションを指定します。

構文

<remarks>description</remarks>  

パラメーター

description
メンバーの説明。

Remarks

<remarks> タグを使用して、型の情報を追加し、<summary> で指定された情報を補足します。

この情報はオブジェクト ブラウザーに表示されます。 オブジェクト ブラウザーについては、「コードの構造の表示」を参照してください。

コンパイル時に -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 のコメント用タグ