== 標準ドキュメント用コメントの書き方 ==
=== 1.モジュール (標準モジュール, クラスモジュール, ユーザコントロールなど) レベルのコメントの書き方 ===
=== 2.メソッド(Sub, Function, Property)レベルのコメントの書き方 ===
{{{
'===============================================================================
' Name: [function, property もしくは subプロシージャの名前]
' Input:
' [引数のリスト(ByRef|ByVal, 型と 説明文付き)]
' Output:
' [戻り値の型と説明文]
' Purpose: [説明文(要約)]
' Remarks: [注意事項]
' Author: [(省略可) 作成者の名前]
' Version: [(省略可) 内部バージョン番号]
'===============================================================================
}}}
'''例'''
{{{
'===============================================================================
' Name: Function countryCode
' Input:
' ByRef ud As Variant - ユーザへの参照を指定します。
' ByVal intNewValue As Integer - 新しい国の電話コードを指定します。
' Output:
' Integer - ユーザの設定前の国名略号
' Purpose: ユーザに対する国名略号を設定します。
' Remarks: この値はWindows2000で使用されません。
'===============================================================================
Public Function countryCode(ud As Variant, ByVal intNewValue As Integer) As Integer
}}}
=== 3.列挙値へのコメントの書き方 ===
{{{
'===============================================================================
' Name: [名前]
' [列挙値のリスト(説明文付き)]
' Purpose: [説明文(要約)]
' Remarks: [注意事項]
' Author: [(省略可) 作成者の名前]
' Version: [(省略可)内部バージョン番号]
'===============================================================================
}}}
'''例'''
{{{
'===============================================================================
' Name: Enum weekDay
' MONDAY - 月曜日
' TUESDAY - 火曜日
' WEDNESDAY - 水曜日
' THURSDAY - 木曜日
' FRIDAY - 金曜日
' SATURDAY - 土曜日
' SUNDAY - 日曜日
' Purpose: 曜日の有効な値
'===============================================================================
Public Enum weekDay
MONDAY = 1
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
End Enum
}}}