LoginSignup
3

More than 1 year has passed since last update.

posted at

updated at

【初心者でもできる‼】Javadocの書き方

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

  • 結果は以下のようになります。

01.png

  • html フォルダが作成されていることを確認します。 
                             
    02.png

  • html フォルダ内の index.html を開きます。 

03.png

  • ブラウザが起動し、 Sample.html が表示されます。

04.png

  • 画像のように表示されれば成功です。

4.GitHub

GitHubにソースコードを公開しています。

5.関連

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
What you can do with signing up
3