[salesforce]ApexDoc – Apexドキュメント作成ツール

By |8月 6, 2012|salesforce, |0 comments


今回はJavaDocのように、Apexコードのドキュメント作成ができる“ApexDoc”をご紹介。

ApexDoc – A Salesforce Code Documentation Tool

便利なツールなのですが、そのままだと日本語に対応していません。
下記手順を参考に導入してください。

Eclipseプラグイン導入手順

1.新しいプロジェクトを作成「SVNからプロジェクトをチェックアウト」
(ロケーションは“http://apexdoc.googlecode.com/svn/trunk/”)
2.FileManager.javaのdos.writeBytes(contents);をdos.write(contents.getBytes());に書き換える
参考URL:http://d.hatena.ne.jp/mihoko_az/20111007/1317965844
3.プラグインを作成する
参考URL:http://thinkit.co.jp/free/tech/11/2/1.html
4.作成したプラグインをEclipseの“plugins”フォルダに入れる

プラグイン利用方法

1.プロジェクトの「*.cls」ファイルの入ったフォルダを右クリック
2.「Force.com」項目に「Generate ApexDoc…」が追加されているのでそれを選択。
3.ダイアログで下記項目を設定する。
Target Directory(必須):
ドキュメントを書き出すフォルダを選択
Home HTML File(任意):
「index.html」を開いた際に表示されるHTMLファイルを選択
Author File(任意):
画面上部に表示される作者情報を記述するファイルを選択
Scope to document(チェックボックス):
「global」「public」「private」のうちドキュメント化したいアクセス修飾子を選択

下記のようなドキュメントが作成されます。

ApexDoc サンプル画面

注意点

・コメントは必ず「/**」から始めて、「*/」で終わるように記述する
・複数行に渡ってコメントしたい場合はBRタグを使う
・現在サポートしている属性は下記のみ
@author 作者
@date 作成日時
@param パラメータ(複数サポート)
@description 説明
@return 返り値

使ってみた感想

JavaDocと比べると対応しているコメントが少なかったり、
ドキュメントのレイアウトや外観が劣っていたりしますが、
手軽にドキュメントを作成したいときには活用できるツールです。

ドキュメント用のコメントを自動生成するプラグインがあればより使い易くなりそうですね。

参考URL
ApexDoc – A Salesforce Code Documentation Tool
ApexDoc Eclipse Plugin For Force.com IDE
ApexDoc – Google Code
[salesforce]ApexDocとは – 紺青日記-こんあおにっき

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です