別名

JIGドキュメントにはパッケージ名やクラス名、メソッド名などを出力しますが、実装されている名称をそのまま使用するとドキュメントとしては読み取りづらいものになりがちです。JIGでは別名をつけられます。

別名はドキュメントコメントで記述します。以下はパッケージに別名をつける場合の package-info.java です。

 /**
  * サンプルパッケージ
  *
  * 別名に使用されるのは一行目のみです。二行目以降に書かれているものは別名には使用されません。
  */
 package sample;

上記のように記述した場合、パッケージ関連図では別名とパッケージ名が併記されます。