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

上: 使い方

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

次: XMLドキュメント用コメントの書き方

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

　Java Styleのコメントは、一般的に使われている（例：Doxygen）ので、コメントについての勉強時間が少なくて済むというメリットがあります。

　スペースはいくらあっても無視されます。なので、コメントの体裁は自由にできます。それと、コメントにはHTMLタグを含められます。

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

''
' モジュールの説明
' 複数行にわたり記述できます。
' 
' @remarks 注意事項などを書く
' @author 作成者の名前
' @version 0.0.20
' @date 20010826

※「@remarks」の内容と「@date」の内容は出力されません。

2.メソッド(Sub, Function, Property, Event, モジュール内変数や定数)レベルのコメントの書き方

例

''
' ユーザに対する国名略号を設定します。
'
' @param ud	ユーザへの参照を指定します。
' @param intNewValue 新しい国の電話コードを指定します。
' @return 	ユーザの設定前の国名略号
' @remarks この値はWindows2000で使用されません。

Public Function countryCode(ud As Variant, ByVal intNewValue As Integer) As Integer

3.列挙値やユーザ定義型(Enum , Type)

例

''
' 四季
'
' @param spring	春に関するもの
' @param summer	夏に関するもの
' @param autumn	秋に関するもの
' @param winter	冬に関するもの

Public Enum seasons
	spring
	summer
	autumn
	winter
End Enum

4.インタフェース(Implements)

例

''
' My report manager は
' VBDOXが必要とするインタフェースを実装します。
'

Implements IReportManager

その他

「@see」タグが使えます(クラス、ユーザ定義型、列挙値への参照が可能)。

例

 @see Project1.Class1
 @see Class1
 @see Enum1

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

上: 使い方

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

次: XMLドキュメント用コメントの書き方