1.Javadocとは
JavadocとはJavaのクラスやメソッドの仕様についてまとめる仕組みのことで、「/**」から始まり、「*/」で終わる形で記述されます。下に例を挙げます。
この写真では引数に1を足すaaaというメソッドについて、Javadocを用いています。
Javadocでは@は特殊な文字として認識されます。「@param」など、@を先頭に置いたものをJavadocタグと言います。
「@param」は引数、「@return」は戻り値、「@author」はプログラムの著者をそれぞれ意味します。
Javadocタグは他にもいろいろ存在します。
2.Javadocを用いる意味
Javadocを用いて、クラスやメソッドの説明を行うと、該当するクラスやメソッドが他のクラスで呼び出された際にもそれらにカーソルを合わせるだけで、記述した内容を確認することができます。先ほどのaaaメソッドにカーソルを合わせると下のような説明を見ることができます。
よって、Javadocを用いることでコードが視覚的に読みやすくなり、チームでの作業がやりやすくなると言えるでしょう。また、コードとは別に仕様などを説明した文書などが必要なくなるので、管理のしやすさという意味でも大きなメリットが得られると考えられます。
3.eclipseからJavadocをhtmlファイルで出力する方法
①Javadocを出力したいプロジェクトを右クリックし、エクスポートを選択します。
②Java下にあるJavadocを選択し、「次へ」を押下します。
③宛先にファイルを生成したい先を入力し、「完了」を押下します。
④指定した先にdocというフォルダが生成されています。
⑤docの中に「AAA.html」というファイルが生成されています。これが、「AAA.java」についてのJavadocについてのhtmlファイルになります。
このような流れで、Javadocをhtmlファイルとして生成できました。
実際に開いてみると、このように表示されます。
クラス内の仕様を即座に確認できるので、便利に使うことができるのではないでしょうか。