Grails: Альтернативы Grails Doc?

Документация, созданная при запуске grails doc, не вполне удовлетворительна в моих глазах. Например, действия в контроллерах отображаются в качестве свойств в документации, хотя я бы хотел иметь дополнительный раздел для разделения действий от реальных свойств (строки и т.д.).

Существуют ли какие-либо инструменты, которые работают с комментариями, подобными JavaDoc, и обеспечивают лучшую производительность для проектов Grails? Он должен быть либо знаком с Grails (т.е. Понимает, что закрытие в контроллерах - это фактически действия), либо разрешить явное пометку (например, комментарий @section Actions делает абзац в разделе "Действия" )

Ответ 1

Взгляните на проект grails-new-doc.

Ответ 2

Ознакомьтесь с плагином Grails Runtime Docs (http://grails.org/plugin/grails-runtime-docs). Он будет генерировать документацию groovy из среды выполнения, включая динамические методы, добавляя "Сводка динамических методов" и "Детализированный динамический метод" в сгенерированные html-документы, которые предоставляют их исходную информацию. Это больше Grails знает и классифицирует классы в контроллеры, команды, домены, службы и библиотеки тегов. Примечание. Я разработчик Grails и внесли этот плагин с открытым исходным кодом в Grails. Надеюсь, вы сочтете это полезным.

Ответ 3

Похоже, вы используете более старую версию Grails.

Последняя версия Grails содержит много улучшений в документе grails doc. Кроме того, Grails теперь рекомендует, чтобы действия контроллера были закодированы как методы, а не закрытия, что может решить вашу проблему.

Если вы обеспокоены обновлением, я использую Grails с 2008 года и всегда обновляюсь при выходе новых версий.

Никогда не прошло более одного дня, чтобы обновить Grails, обновить код, чтобы устранить любые документированные "взломанные изменения", запустить тесты и вернуться, если я найду какие-либо проблемы.

Поскольку обновление настолько простое, я всегда стараюсь не отставать от последней стабильной версии.

Кстати, плагины могут быть проблематичными. Вы должны или конечно пройти тесты для любых подключаемых модулей. На самом деле лучшие плагины уже включают тесты, которые вы можете запустить.