1
Для класса или метода Groovy или Java я обычно включал бы любую документацию на уровне API в комментарий к документу (например, комментарий Javadoc), а не обычный комментарий. Каков аналогичный способ добавления таких комментариев к скрипту Groovy?Есть ли способ прикрепить комментарий к Javadoc к сценарию Groovy?
Мне лично все равно, насколько инструмент Javadoc собирает документацию. Однако документация о цели скрипта Groovy кажется концептуально аналогичной комментарию к доктору о классе; поэтому я бы интуитивно ожидал, что они будут в комментарии к док-тету. Если моя интуиция ошибочна, а теги doc не являются стандартным способом комментирования намерения скрипта Groovy, то является предпочтительным методом документирования цели скрипта?
[Groovydoc] (http://docs.groovy-lang.org/latest/html/documentation/#_groovydoc_the_groovy_java_documentation_generator) - это то, что вам нужно? Вот пример использования [groovydoc в скриптах] (http://www.javaworld.com/article/2074120/core-java/documenting-groovy-with-groovydoc.html). – dmahapatro
@dmahapatro - Эта ссылка действительно показывает то, что я просил. Однако это не совсем авторитетно. Кроме того, если вы посмотрите на вывод GroovyDoc для класса по сравнению с сценарием в примере, вы увидите, что документы класса уровня выводятся в примерах класса GroovyDoc, но не в примерах сценариев. Это заставляет меня думать, что это не может быть «правильным» способом. –