<summary> (Visual Basic)
メンバーの概要を指定します。
構文
<summary>description</summary>
パラメーター
description
オブジェクトの概要。
Remarks
<summary>
タグを使用して、型または型メンバーを記述します。 型の説明に補足情報を追加するには、<remarks> タグを使用します。
<summary>
タグのテキストは、IntelliSense での型に関する唯一のソースで、オブジェクト ブラウザーにも表示されます。 オブジェクト ブラウザーについては、「コードの構造の表示」を参照してください。
コンパイル時に -doc を指定して、ドキュメント コメントをファイルに出力します。
例
この例では、<summary>
タグを使用して ResetCounter
メソッドと Counter
プロパティを記述します。
''' <summary>
''' Resets the value of the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
Get
counterValue += 1
Return counterValue
End Get
End Property
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
.NET