KENスクールブログ | パソコン教室・パソコン講座なら個別指導のKENスクール

EclipseでのJavadoc生成の手順に関する記事です

環境（以下の環境で動作確認をしています）

• Windows 7
• Pleiades Eclipse 4.6 Kepler
• JavaSE8

目次

• Javadocとは
• Javadocのタグ
• EclipseからJavadocの生成手順

Javadocとは

Java言語のソースコードからプログラムについて説明するドキュメント（リファレンス）を一定の規則に従って生成する仕組みです。クラスの概要やメソッドの概要をJavadocで記述すると、その情報からHTML形式のドキュメントファイルを生成してくれます。

Javadocのタグ

Javadocの記述は、Java言語のソース内に、「/**」 と 「*/」の間に専用のタグを使って記述します。代表的なJavadocのタグと説明を下記に記載しています。

EclipseからJavadocの生成手順

1. ソースコード内にJavadocコメントを入力します。
   
2. Eclipseのメニューから「ファイル」→「エクスポート」→「Java」→「Javadoc」を選択します。
   
3. 書き出し先を確認し、「完了」を押します。
   
4. プロジェクト内にHTMLファイルが生成されます。
   
5. 生成されたHTMLをブラウザで開くと、内容の確認ができます。
   

Javadocで作成されたリファレンスは基本的にチーム全体で共有するものです。実際の開発現場では、個人の感覚で作成せずに、プロジェクト全体のルールに従ってJavadocコメントを作成しましょう。