nDiki : Javadoc

Javadoc

Javaソースコードからドキュメントを生成するツール。 標準ではHTML形式のドキュメントを生成する。 doclet を使用する事で、他の形式のドキュメントを生成する事もできる。

同様のツールとしては doxygen などがある。

パッケージの説明を書くには?

パッケージのソースディレクトリに package.html を作成する。 形式は html。bodyの中にドキュメントを書く。 最初の行は、パッケージの要約文を書く。

-link オプション に与える URL

生成するドキュメントが外部参照しているクラス(例えばJava 2 プラットフォームAPI等)へのリンクを作成するには -link オプションを指定する。

 -link オプションに与えるURL(package-list ファイルのあるところ)

スポンサード リンク

2001年12月4日 (火)

17:15 Checkstyle を ant に追加

CheckstyleJava のコードのスタイルや Javadoc 用コメントのチェックをする Java クラス(コマンドラインツール / Ant タスク)。

Debian のパッケージにはまだなっていないので、公式サイトからとってきて .jar ファイルを /usr/local/share/java に放りこむ。 必要なライブラリの ANTLR と Regexp は Debian パッケージになっているので入れとく。

コマンドラインでちょっと試した後 build.xml にターゲット追加して統合。 これで JUnit とあわせて、コードの品質があがるようにがんばろ。

スポンサード リンク
[ 12月4日全て ]

2003年11月19日 (水)

pod2latex

仕事で書いた Perl モジュールAPI 仕様を紙媒体にしなければならないので、今回は pod2latex を使ってみる。

 pod2latex -modify -full -out hoge-utf8.tex lib

で lib ディレクトリ以下の *.pm の Pod が集められて hoge-utf8.tex になる。ソースを UTF-8 で書いているのでこれを lv などで EUC-JP に変換して、platex してdvipdfmx

前に Javadoc から LaTeX に落とした時に比べて非常にすんなりと変換してくれる。 '=item foo([opt])' とかすると ] 文字が落ちたりする以外は特に今のところ目につく問題なし。

ま、いざとなったらスクリプトに手を入れて直せるだろうし、なかなかいいんじゃないでしょうか。

[ 11月19日全て ]

About Me

Naney Naney (なにい)です。株式会社ミクシィで SNS 事業の部長をしています。

nDiki1999年1月に始めたコンピュータ日誌を前身とする NaneyWeb 日記(兼パーソナルナレッジベース)です。ちょっとしたノートは nNote にあります。

※内容は個人的見解であり所属組織とは関係ありません。

月別インデックス
Process Time: 0.059513s / load averages: 2.71, 1.01, 0.69
nDiki by WATANABE Yoshimasa (Naney)
Powered by DiKicker