Apache Forrest作为代码文档解决方案

时间:2009-09-21 17:48:55

标签: java maven-2 documentation-generation apache-forrest

最近,我一直在研究Apache Forrest作为代码文档解决方案。来自Apache的网站

  

“Apache Forrest™软件是一个   发布转换的框架   从各种来源输入到   一个或多个统一演示   输出格式。模块化和   可扩展的插件架构   Apache Forrest基于Apache   茧和相关行业   分开演示的标准   来自内容。福雷斯特可以产生   静态文档,或用作   动态服务器,或由其部署   自动化设施。“

我想知道Apache Forrest是否可以用作组织和发布一些Java代码的文档的方法,这些代码与JavaDoc注释一起完成。我知道JavaDoc可以自己做,但我觉得Apache Forrest提供了一些额外的自定义。我在Apache网站上找到了如何将其包含在Maven中的说明,但它似乎是针对Maven 1.x而定制的,我使用的是Maven 2.这样的事情可能吗?如果是这样,那么整合它的最佳方式是什么?

提前致谢。

1 个答案:

答案 0 :(得分:6)

Documenting Projects with Apache Forrest中,作者写了关于 Forrest Alternatives 的文章:

  

如果你熟悉Maven,你可以   想知道为什么有人会打扰   与福雷斯特。 Maven做的一切   福雷斯特做了,还有更多:   完全自动化您的构建,   附加JUnit和CVS报告和   各种其他有用的   基本信息   文档。它甚至提供   目标是自动安装新的   将网站生成到远程主机上。

     

我曾经使用过Maven   项目,这是一个令人印象深刻的   包。学习曲线不是   比福雷斯特的基本情况要糟糕得多   使用,因为你不必学习   Ant,如果你使用Maven,可以说是   甚至更少的建立项目   从头开始。福雷斯特作为一个整体   但不那么复杂,如果你不这样做   需要Maven提供的一切,你   可能想从福雷斯特开始   如果需要,请稍后迁移到Maven。   如果你有一个,福雷斯特也会更好   现有的大型系统基于   Ant:它允许你添加Maven风格   网站生成逐步增加   而不是重写所有的构建   Maven-ize项目的脚本。

     

就纯文档而言   替代品,另一个可靠的选择   有很多开源社区   支持是DocBook。你可以写   带有DocBook的747手册:   它是最终的SGML(或XML;那里   是两个版本)方言   技术写作。 XML变体有   来自诺曼的一套漂亮的样式   Walsh可以生成HTML,PDF,RTF   (Microsoft Word)和其他格式   来自DocBook源码。我觉得福雷斯特   XML方言占80%   案例,学习量小得多   曲线,但对于一个大型项目   还需要制作印刷品   文档,DocBook优点   考虑。请注意,如果你想   从DocBook,Forrest迁移   支持渲染的子集   DocBook / XML也是如此,但事实并非如此   很好的支持。福雷斯特不瞄准   成为一个成熟的DocBook   渲染器将​​来的任何时候,   根据其中一个,其中一个   开发人员,所以我不会依赖   它作为新文档的格式   在福雷斯特。

所以,因为你已经在使用Maven,我真的很想知道你为什么要看福雷斯特。如果您对Maven的潜力仍有疑问,请查看Maven Doxia

如果你想使用DocBook,如果Maven通过Doxia提供的原生支持太有限,那就有Docbkx Maven Plugin(优先于Maven Docbook plugin)。