標準ドキュメント用コメントの書き方 - VBDOX日本語化 Wiki - VBDOX日本語化

Up: 使い方

Prev: 使い方

Next: Java Styleドキュメント用コメントの書き方

標準ドキュメント用コメントの書き方

注意：タグ（NameやPurpose）の順序は重要です（※Nameの前にPurposeを書いたりするとうまく解析されません）。タグの前にはスペースが必要です。メソッドの引数や列挙値の値を書くときはスペースを4つ（1タブ）が必要です。各引数、列挙値のコメントは行を分けてください。説明文にはHTMLを含められます。また、説明文は複数行に渡ってもかまいません。

　説明、著作権、バージョン番号はプロジェクトファイルから抽出します。これらの情報はプロジェクトのプロパティ画面（VB6.0なら「プロジェクト」メニューの「*のプロパティ」）にて変更できます。

　生成結果はプロジェクトディレクトリの新規サブディレクトリに生成されます。生成された全てのファイルはスタイルシートへリンクしています。

　このプログラム(VBDOX)はMicrosoft HTML Help Workshop プロジェクトファイル(help.hhp)、コンテンツファイル(contents.hhc)、インデックスファイル(index.hhk)も生成します。

1.モジュール (標準モジュール, クラスモジュール, ユーザコントロールなど) レベルのコメントの書き方

'===============================================================================
' Name: [モジュールまたはクラスの名前]
' Purpose: [(省略可能) 説明文(要約)]
' Functions:
'     [関数のリスト(アルファベット順)]
' Properties:
'     [プロパティのリスト(アルファベット順)]
' Methods:
'     [メソッドのリスト(アルファベット順)]
' Author: [作成者の名前]
' Start: [開発開始日]
' Modified: [最終更新日]
'===============================================================================

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

このドキュメントはVODOXのサイト(英)を元に作成しました

Up: 使い方

Prev: 使い方

Next: Java Styleドキュメント用コメントの書き方