<see> (Visual Basic)
更新 : 2007 年 11 月
他のメンバへのリンクを指定します。
<see cref="member"/>
パラメータ
- member
現在のコンパイル環境からの呼び出しに利用できる、メンバまたはフィールドへの参照。コンパイラは、指定されたコード要素が存在することを確認してから、member を出力先 XML 内の要素名に渡します。member は、二重引用符 (" ") で囲みます。
解説
テキスト内でリンクを指定するには、<see> タグを使用します。"参照" のセクションに示すテキストには、<seealso> (Visual Basic) タグを使用します。
コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。
使用例
この例では、<see> タグを UpdateRecord の解説セクションで使用して、DoesRecordExist メソッドを参照します。
''' <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