コーディング規約 トップページVisual Basic コーディング規約 目次 

1.10 XMLドキュメントコメント(Visual Basic 2005以降)

XMLドキュメントコメントからコメントを抜き出すために、下記のようなコメント形式にも対応している。

プロシージャのXMLドキュメントコメントは、<summary>,<param>などの全てのタグに対応している。
変数、定数、InterfaceなどのXMLドキュメントコメントは、<summary>のみ対応している。
XMLの構文エラーの場合は、ドキュメントに出力されない。

注意
Visual Basic .NET 2002/2003では、XMLドキュメントコメントはサポートされておりません。
その為、【A HotDocument】 for Visual Basic .NET 2002/2003ではXMLドキュメントコメントは使えません。

■ XMLドキュメントコメントの例

''' <summary>
''' Classコメント
''' Classに関する説明を出力します。
''' </summary>
Public Class Form1
  ''' <summary>
  ''' XMLドキュメントコメントの説明を出力します。
  ''' 以下のタグはコメントを抽出できます。
  ''' </summary>
  ''' <remarks>
  ''' 機能説明はこのように記述します。
  ''' </remarks>
  ''' <param name="Coumment">出力コメント文字列</param>
  ''' <param name="Size">出力コメントサイズ</param>
  ''' <returns>
  ''' 返り値はこのように記述します。
  ''' </returns>
  ''' <exception>
  ''' 例外処理はこのように記述します。
  ''' </exception>
  Function WebPageBuildComment(ByVal Coumment As String, ByVal Size As Integer) As String
  End Function

  ''' <summary>
  ''' ループの数
  ''' </summary>
  Public Const LOOP_COUNT = 2

  ''' <summary>
  ''' ボタンのサイズ
  ''' </summary>
  Public nSize = 10

  ''' <summary>
  ''' Interfaceコメント
  ''' </summary>
  Public Interface InterSample
  End Interface

  ''' <summary>
  ''' Structureコメント
  ''' </summary>
  Public Structure PERSON
   Dim Name As String ' 名前
   Dim Age As Integer ' 年齢
  End Structure

  ''' <summary>
  ''' Enumコメント
  ''' </summary>
  Public Enum WeekDay
   Sun = 1 ' 日曜日
   Mon = 2 ' 月曜日
   Tue = 3 ' 火曜日
   Wed = 4 ' 水曜日
   Thu = 5 ' 木曜日
   Fri = 6 ' 金曜日
   Sat = 7 ' 土曜日
  End Enum

  ''' <summary>
  ''' Delegateコメント
  ''' </summary>
  Public Delegate Sub MyDelegate(ByVal i As Integer)
End Class