More than 5 years have passed since last update.

package-info.javaを書こう

Posted at 2016-03-18

下記のように、javadocのoverviewで、パッケージの概要（description）のコメントを表示させるには、各パッケージにpackage-info.javaを追加して、それにjavadocコメントをつければよいです。（画像はjoda-timeのものです。）

package-info.java

/*
 * パッケージの説明.
 */
package org.hoge.xxx;

Eclipseなら、パッケージを新規作成すると、一緒にこのファイルも作成¹してくれたりします。（昔はうぜぇとかいって、削除していた自分が恥ずかしい...）

ある程度パッケージ構成が固まってきたら、これにjavadocコメントをつけると、自分にも他の人にもパッケージの役割を明示することになるので、良いと思います。

参考サイト