EclipseによるJavadocの生成方法を現役エンジニアが解説【初心者向け】

EclipseによるJavadocの生成方法について、テックアカデミーのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。

そもそもJavaについてよく分からないという方は、Javaとは何なのか解説した記事を読むとさらに理解が深まります。

 

 

Javadoc（Javaドキュメンテーション）とは

Javadocは、特定の書式に従って記述されたJavaプログラムのソースコードから、そのプログラムについて説明するドキュメント（リファレンス）を一定の規則に従って生成する仕組みです。

クラスの概要やメソッドの概要をJavadocで記述することで、HTML形式のドキュメントファイルを生成します。このドキュメント形式はJavaクラスにおける仕様書の標準書式となっています。

 

EclipseによるJavadocの生成方法

IBMの開発環境であるEclipseでJavadocを生成する手順は以下のようになります。

Javadocの記述は、Javaプログラムのソースコード内に、「/**」と「*/」の間に記述します。

Javaプログラムのコメントは「/*」で始まり「*/」で閉じるので、Javadocとコメントを混同しないように気をつけましょう。

 

また、Javadocの中では「@」は特殊な記号として扱われます。例えば、「@author」は開発者名、「@exception」はメソッドが投げるクラスとその説明、「@param」はメソッドの引数名と引数の概要、「@return」はメソッドの戻り値、といった具合です。

Javadocの記述完了後、Eclpse【脱字】のメニューから「ファイル」＞「エクスポート」をクリックし、「Java」＞「Javadoc」を選んでJavadocファイルを生成します。

 

[PR] 未経験からWebエンジニアを目指す方法とは

EclipseによるJavadocの生成方法での便利なショートカット

EclipseでJavadocを記述する際には、コメントを挿入したいメソッドやフィールドの宣言文上にカーソルを置き、下記のショートカットキーを使用しましょう。簡単にフォーマットを追加することができるでしょう。

Windows	Alt + Shift + J
Mac	option + command + J

 

実際に生成してみよう

下記のようなサンプルコードを使用します。

public class Sample {
    public int area(int width, int height) {
        return width * height;
    }
}

このサンプルコードに対して、Javadocに対応したコメントを記述すると下記のようになります。

/**
* 面積
* @author Taro.Yamada
*/
public class Sample {
    /**
     * 四角形の面積を求める
     * @param width 幅
     * @param height 高さ
     * @return 面積
     */
    public int area(int width, int height) {
        return width * height;
    }
}

そして、Eclipseのメニューから「ファイル」＞「エクスポート」をクリックしてみましょう。。

「Java」＞「Javadoc」をクリックし、「次へ」をクリックします。

• 「Javadocコマンド」にjavadocが記述されていることを確認し、空欄になっている場合は「構成」ボタンを押してjavadocを指定してください。
• 「Javadocが生成される型の選択」でJavadocを生成するファイルを選択しましょう。
• 「宛先」で出力先を指定し、「完了」をクリックします。

そして、プロジェクト内にHTMLファイルが生成されます。

生成されたHTMLをブラウザで開くと内容の確認が可能です。

Javadocに対応した形でコメントを記述しておくだけで、即座にクラスやメソッドの仕様書を作成できるため非常に便利です。しかし、実際の開発現場では、プロジェクト毎にJavadocの記述ルールが決まっているため、個人の感覚で作成せずにルールに従ってJavadocコメントを作成しましょう。

 

執筆してくれたメンター

松井紀明 メーカー系で17年エンジニアとして勤務後、現在はフリーのエンジニアとしてリモートワークで働いています。 Java、Perl、COBOL、最近ではRuby、PHP等、様々な言語での開発を経験しています。TechAcademyではJavaコースを担当しています。

Javaを学習中の方へ

これで解説は終了です、お疲れさまでした。

• つまずかず「効率的に」学びたい
• 副業や転職後の「現場で使える」知識やスキルを身につけたい

プログラミングを学習していて、このように思ったことはありませんか？

テックアカデミーのJavaコースでは、第一線で活躍する「プロのエンジニア」が教えているので、効率的に実践的なスキルを完全オンラインでしっかり習得できます。

合格率10%の選考を通過した、選ばれたエンジニアの手厚いサポートを受けながら、JavaやServletの技術を使ったWebアプリケーション開発を学べます。

まずは一度、無料体験で学習の悩みや今後のキャリアについて話してみて、「現役エンジニアから教わること」を実感してみてください。

時間がない方、深く知ってから体験してみたい方は、今スグ見られる説明動画から先に視聴することをおすすめします！