Javadoc комментирует в модуле-info

Question

Функция модулей Java 9 добавляет (более высокий уровень) файлы module-info в дополнение к файлам package-info, которые существовали ранее.Могут ли module-info.java (исходные коды) файлы содержать размеченные комментарии, которые инструмент JavaDoc будет извлекать и представлять (с пользой) в качестве документации уровня модуля?

Answer 1

Да.И теги, поддерживаемые при объявлении модуля:

Объявление модуля

{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}

Источник : - Документация Комментарий Спецификация для стандартного доклета

Среди них недавно представленные теги, которые могут вас заинтересовать:

1. @index
2. @summary

, а затем module специфично

@provides @uses

Answer 2

Одним словом - да.Например, вы можете увидеть, как Javadoc в Java 9 имеет документацию на уровне модулей, которая затем перечисляет в них пакеты с их документацией.Пакеты, в свою очередь, содержат классы с их документацией.

В качестве быстрого примера, посмотрите документацию модуля jdk.shell .