JavadocのApex版。
Eclipseのプラグインとして提供。
- 日本語化
- マルチバイト対応していないが、FileManager.javaを書き換えることで対応可能。
- SVNからプロジェクトを作成(http://apexdoc.googlecode.com/svn/trunk/)
- FileManager.javaを書き換え(2箇所あり)
- dos.writeBytes(contents); → dos.write(contents.getBytes());
- プラグイン作成
- 作成したプラグインをpluginsフォルダに保存してEclipseを起動
- 使い方
- [プロジェクト]>src>classesフォルダを右クリック
- [Force.com]>[Generate ApexDoc...]を選択
- 以下の項目を設定して[生成]ボタンをクリック
- Target Directory ← ここにApexDocができる
- Home HTML File(任意)
- Author File(任意)
- Scope to document(ドキュメント化するアクセス修飾子を選択)
- global
- public
- private
- ApexDocのタグ
タグ 記述内容 @author 開発者名を記述する。 @date クラスまたはメソッドの作成日を記述する。 @param メソッドの引数や総称型のパラメータを記述する。引数の数だけ記述する必要がある。引数名と引数の概要を記述する。 @description クラスまたはメソッドの概要を記述する。 @return メソッドの戻り値を記述する。戻り値がvoidの時は記述しなくて良い。