Grails：Grails Doc 的替代品？ [关闭]

Posted 2023-05-07

【中文标题】Grails：Grails Doc 的替代品？ [关闭]

【英文标题】：Grails: Alternatives to Grails Doc? [closed]

【发布时间】：2011-04-07 21:03:11

【问题描述】：

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

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

【参考方案1】：

看看grails-new-doc 项目。

【参考方案2】：

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

【讨论】：

您应该披露该链接指向您创建的文档

@Skuld ：感谢您的建议。我刚刚了解了披露并相应地编辑了我的答案。该页面是由 grails 为作者在贡献插件时创建的。谢谢。

别担心，请注意，如果您发帖过多且未披露，您可能会被标记为垃圾邮件。 :)

【参考方案3】：

听起来您正在运行旧版本的 Grails。

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

如果您担心升级，我从 2008 年开始使用 Grails，并且总是在新版本出现时升级。

升级 Grails、更新代码以解决任何记录在案的“重大更改”、运行测试以及在发现任何问题时恢复的时间从未超过一天。

由于升级如此简单，我总是尽量跟上最新的稳定版本。

顺便说一句，插件可能会出现问题。您应该或者当然，对您使用的任何插件进行测试。事实上，更好的插件已经包含测试，你可以运行。

【讨论】：

非常感谢。几个星期前，我们已经升级到最新版本的grails，但是如你所见，这个问题是2010年的。无论如何，我会尝试新的grailsdoc。