1.事前知識
または
事前知識として、上記リンクの内容が必要です。
2.Javadocとは
-
Javadocとは、サン・マイクロシステムズが開発したコンピュータソフトで、JavaのソースコードからHTML形式のAPI仕様書を生成するものである。 - Javadocコメントは
/**と*/の間にコメントを記述する。
3.Javadocの書き方とドキュメント作成
Sample.java
/**
* @author 作成者名
* @version x.x.x
*/
/**
* Javadocの解説用メインクラス
*/
public class Sample {
/**
* mainメソッド
* @param args 使用しない
*/
public static void main(String[] args) {
// 文字列の表示
System.out.println("JavaDocサンプル");
}
}
- 上記の文をコピーして、文字コードは
S-JISを指定し、ファイル名をSample.javaで保存し、コマンドプロンプトでjavadoc -d html Sample.javaを実行します。↓↓
$ javadoc -d html Sample.java
- 結果は以下のようになります。
-
htmlフォルダが作成されていることを確認します。
-
htmlフォルダ内のindex.htmlを開きます。
- ブラウザが起動し、
Sample.htmlが表示されます。
- 画像のように表示されれば成功です。
4.GitHub
GitHubにソースコードを公開しています。