<returns> (Visual Basic)
プロパティまたは関数の戻り値を指定します。
<returns>description</returns>
パラメーター
- description
戻り値の説明。
解説
<returns> タグは、メソッド宣言のコメント内で使用され、戻り値について説明します。
コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。
使用例
この例では、<returns> タグを使用して 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