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

1.11 キーワードの変更

 
プロシージャの頭書きのキーワードは自由に追加,削除できる。
変更する場合には,【A HotDocument】のメニューの[環境設定(E)]-[コメント(C)]より設定をする。
また、XMLドキュメントコメントのコメントタグも自由に追加できる。

■プロシージャ頭書きのコメントの例

'
' 機能   : 文字列の分割
'
' 返り値  : 分割後の文字列
'
' 引き数  : ARG1 - 対象となる文字列
'
' 作成日  : 2007年09月15日
'
' 作成者  : 今井 浩司
'
' 機能説明 : 文字列を分割して配列にセットする。
'         最大配列数を超えたら,エラーメッセージを出力する。
'
' 注意事項 : 最大配列数以上の,配列を作らなければいけない。
'

■XMLドキュメントコメント形式のプロシージャ頭書きのコメント例

  ''' <summary>
  ''' XMLドキュメントコメントの説明を出力します。
  ''' 以下のタグはコメントを抽出できます。
  ''' </summary>
  ''' <newtag>
  ''' 新規タグはこのように記述します。
  ''' </newtag>
  ''' <returns>
  ''' 返り値はこのように記述します。
  ''' </returns>