salesforce.com‎ > ‎Force.com IDE‎ > ‎

ApexDoc

2013/09/26 20:32 に Makoto Fukasu が投稿
JavadocのApex版。
Eclipseのプラグインとして提供。

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


Comments