コーディング規約 トップページAccess/Excel/VBA コーディング規約 目次 

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

 
プロシージャおよびプロパティの頭書きのコメントは,次のように記述する。
(1)必要のない項目は削除してもよい。
(2)キーワードと説明文の間のデリミタ(例ではコロン":")は必須である。
(3)「機能」はプロシージャの説明を一行で記述する。

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

'
' 機能   : メッセージ文字列の取得
'
' 返り値  : メッセージ文字列
'
' 引き数  : ARG1 - ファイル番号
'        ARG2 - メッセージインデックス番号
'
' 機能説明 : メッセージ定義ファイルより指定されたメッセージ
'        を取得する
'
' 備考   : 返り値の文字列の最大文字数は80文字
'

VBAのイベントプロシージャ,OCXのイベントプロシージャ,カスタムコントロール,アドインなどのイベントプロシージャ頭書きの一行目のコメントは,以下のように記述する。

■ VBAのイベントプロシージャなどの場合

' @(e)
'
' 機能   : メッセージ文字列の取得
'        ・・・