- PR -

JAVA　DOCについて

1
投稿者投稿内容
JERONIMO
会議室デビュー日: 2003/11/21
投稿数: 15
投稿日時: 2003-11-21 10:29
自分で作成したクラスをJAVA DOCとしてドキュメントにしたいのですが、
どうすればよろしいでしょうか？
宜しくお願いします。

わらび
ベテラン
会議室デビュー日: 2002/08/30
投稿数: 53
投稿日時: 2003-11-21 10:32
javadoc -help
おばけ
ぬし
会議室デビュー日: 2002/11/14
投稿数: 609
お住まい・勤務地: 東京都江東区
投稿日時: 2003-11-22 22:04
引用:

自分で作成したクラスをJAVA DOCとしてドキュメントにしたいのですが、

まあ、Javadocの作り方なんてサイトいっぱいありそうですが、、、

1. ソースコード中にJavadocコメントを埋め込む
2. Javadocコマンドでソースからドキュメントを生成

の2手順です。Javadocコマンド(そのものズバリ"javadoc"と言うコマンド)はJDKに同梱されており、JVM("java"コマンド)と同じディレクトリにあります。

Javadocコメントと言うのは、"/**"で始まり"*/"で終わる特殊なコメントです。
この中に"@xxx"と言う形でキーワードを書くと、JavadocのAPIドキュメントに反映されます。例えば、

コード:
/**
 * サンプル関数
 * @param hoge ホゲ
 * @return メッセージを返す
 * @throws NullPointerException メッセージがnullの場合
 */
public String getHoge(String hoge)
{
  .....
}


ってな感じです。キーワードについては色々あるので、マニュアルを読んでください。
JERONIMO
会議室デビュー日: 2003/11/21
投稿数: 15
投稿日時: 2003-11-25 09:44
ありがとうございました。日々勉強っす！
1

スキルアップ／キャリアアップ（JOB@IT）