2013-11-24 5 views
3

В JavaDoc для пакета Я документирую (в частности, в файле package-info.java), у меня есть ряд строк, которые выглядят как {@link some.really.long.module.ClassName}, и, естественно, я 'd хотел просто импортировать ClassName и сказать {@link ClassName} вместо этого, но ничего, что я пробовал, работает. Возможно ли это?Потребление импорта для JavaDoc в package-info.java

Я попытался помещать импорт над объявлением пакета и JavaDoc, но это показывает синтаксическую ошибку. Я попытался поставить импорт ниже объявления пакета и JavaDoc, но затем процесс JavaDoc предупреждает Tag @link: reference not found: ClassName.

+0

Исключения выбрасываются. Отображаются ошибки компиляции. – EJP

ответ

0

Просто используйте полное имя в документации по упаковке. JavaDoc будет генерировать HTML, не показывая полное имя (по крайней мере, в версии 1.7), поэтому результаты должны выглядеть хорошо. Это просто более раздражает тип.

0

Вы можете сделать:

This class {@linkplain some.really.long.module.ClassName ClassName} does bla bla bla... 

Это покажет, как

Этот класс ClassName делает бла-бла-бла ...

Смежные вопросы