Grails:Grails Doc的替代品?

时间:2010-09-03 13:55:49

标签: grails documentation javadoc documentation-generation

通过运行grails doc创建的文档在我看来并不完全令人满意。例如,控制器中的操作在文档中显示为属性,但我希望有一个额外的部分将操作与实际属性(字符串等)分开。

是否有任何工具可以运行类似JavaDoc的注释并为Grails项目生成更好的输出?它应该是Grails-aware(即理解控制器中的闭包实际上是动作)或允许显式标记(例如@section Actions注释使段落出现在名为“Actions”的部分中)

3 个答案:

答案 0 :(得分:8)

查看grails-new-doc项目。

答案 1 :(得分:1)

查看“Grails Runtime Docs”插件(http://grails.org/plugin/grails-runtime-docs)。它将从运行时生成groovy文档,包括动态方法,添加“动态方法摘要”&生成的html文档中的“动态方法详细信息”,提供源信息。它更了解Grails并将类分类为控制器,命令,域,服务和标记库。 注意:我是Grails开发人员,并自己为Grails贡献了这个开源插件。希望你觉得它很有用。

答案 2 :(得分:1)

听起来你正在运行旧版Grails。

最新版本的Grails包含grails doc的许多改进。此外,Grails现在建议将控制器操作编码为方法而不是闭包,这可能会解决您的问题。

如果您担心升级,我自2008年以来一直在使用Grails,并且在新版本发布时总是升级。

从未花费超过一天的时间来升级Grails,更新代码以解决任何记录的“重大变更”,运行测试,并在发现任何问题时还原。

由于升级非常简单,我总是尽量跟上最新的稳定版本。

顺便说一句,插件可能会有问题。您当然应该对您使用的任何插件进行测试。实际上,更好的插件已经包含了可以运行的测试。