不幸なことに今まで参加したプロジェクトではJavaDocを成果物として生成する
機会がなかったため、正式な記法を覚えないままここまで来てしまった。
Java:The Good PartsにJavaの利点としても挙げられていたし、
改めてきちんと覚えようと思います。
- JavaDocの概要
JavaDocとはソースコード内にプログラムの仕様を記載し、
HTML形式のAPI仕様書を出力する機能のことである。
ものすごく基本的ではあるが・・・
■概要はoverview.htmlという名前でJavaソースのルートフォルダに配置すること。
■クラスコメント、メソッドコメントの概要には必ずピリオドか句点で終わること。
■htmlを使用−＞つまりZen-Codingの出番。
■パッケージコメントはpackage.htmlかpackage-info.javaに記すことが可能。
※後者はJava SE 5から導入され、アノテーションも指定できるため後者の利用が推奨される。
■jdkのbinフォルダ配下のjavadoc.exeを使用して出力する。
※JDK1.7の場合なら『C:\Program Files\Java\jdk1.7.0\bin\javadoc.exe』です
- 概要のサンプル
<html> <body> GoFの23のデザインパターンの学習用です。 </body> </html>
- パッケージコメント（package-info.java）のサンプル
/** * ほげプロジェクトのユーティリティパッケージ。 * @since X.X */ package com.hogehoge.hoge_project.util
- 参考パス
- 作者: Jim Waldo,矢野勉,笹井崇司
- 出版社/メーカー: オライリージャパン
- 発売日: 2011/02/24
- メディア: 大型本
- 購入: 3人 クリック: 148回
- この商品を含むブログ (36件) を見る
