让开发自动化化一键通

《让开发自动化化一键通》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、让开发自动化:文档化一键通自动生成开发人员和用户文档PaulDuvall,CTO,StelligentIncorporatedPaulDuvall是StelligentIncorporated的CTO，该公司是一家咨询公司，在帮助开发团队优化Agile软件产品方面被认为是同行中的翘楚。他是Addison-WesleySignature系列书籍ContinuousIntegration:ImprovingSoftwareQualityandReducingRisk（Addison-Wesley，2007年

2、）的作者之一。他对UML2Toolkit（Wiley，2003年）和NoFluffJustStuffAnthology（PragmaticProgrammers，2007年）也有贡献。简介：项目的文档化通常都是交付软件产品时不可避免的难题。但是想象一下如果仅需单击一个按钮就能够生成文档呢？在本期的让开发自动化中，自动化专家PaulDuvall阐述了如何运用开源工具自动生成统一建模语言（UnifiedModelingLanguage，UML）图、构建图、实体关系图（entity-relationshipd

3、iagram，ERD）乃至用户文档。查看本系列更多内容本文的标签：ant,java_技术,应用开发,开放源码标记本文！发布日期：2008年6月24日级别：初级原创语言：英文访问情况：4527次浏览评论：0(查看

4、添加评论-登录)平均分(6个评分)为本文评分很少有软件开发人员愿意为他们的软件开发项目编写文档。然而，除非您永远不想完成您的项目，或者您永远独立进行软件开发，又或者您没有用户—这对一个项目来说可不是一个好现象，否则您就需要用一种方式来向别人交待您的软件的用途。有些开发者误解了AgileManif

5、esto的“可运行的软件优于全面的文档”的说法，以为根本不需要任何的文档资料（请参阅参考资料）。另一方面，多余的文档对用户或其他开发人员来说也是一个负担。我通常寻找一种中间办法。您猜对了：本文将向您展示如何运用自动化来简化项目文档的生成过程，从而减轻这方面的负担。关于本系列作为开发人员，我们致力于为用户自动化流程；但许多开发人员疏忽了自动化我们自己的开发流程的机会。为此，我们编写了让开发自动化系列文章，专门探讨软件开发流程自动化的实践应用，为您介绍何时以及如何成功应用自动化。按照我的经验，有两个关键性的

6、问题制约着软件开发的文档化。第一个问题，似乎没有人会去阅读文档。第二个常见问题就是几乎是在编写文档的同时，它就已经过时了。这两个问题是有着因果联系的：如果文档总是保持最新，那么人们就更有可能去阅读它。自动化生成文档便可以解决这两个问题，它可以保持文档的时效性，从而使它对您的软件用户更加有用。自动化也可能对其他类型的文档有利，但在本文中我将着重阐述如何让那些令人痛苦的文档化任务自动化（请参阅参考资料查找下面列表中提到的工具的链接）：·使用UMLGraph生成当前源代码的UML图。·使用SchemaSpy创

7、建实体关系图（ERD），归档数据库中的表格和关系。·使用Grand生成构建目标以及它们之间的关系的Ant构建图。·使用Doxygen生成源代码文档。·使用DocBook制作用户文档。我将使用一般的方法阐述以下内容：1.描述手动执行每一项任务遇到的问题。2.呈现一个结合使用ApacheAnt和相关的文档/图表生成工具实现自动化的例子。3.展示一个基于代码示例的脚本生成文档的图象。和本系列前面的文章一样，文中所有示例都使用可免费获得的开源工具，您可以在自己的项目中使用。有些工具（例如，UMLGraph和Gr

8、and）会使用一个附带的GraphViz工具，该工具要用到一个由特定工具生成的.dot文件。将代码反向工程到UML中我曾遇到过一些拥有十分美观的UML图的项目—在项目的初始阶段。问题是，在某种特殊情况下，技术负责人无法使模型与源代码同步。或者需要将宝贵的时间浪费在将源代码手动反向工程到模型中。这两种情况都不尽如人意。如果模型无法如实地展示签入到版本控制库中的代码，那么这个UML图构造的再美观也毫无意义。如果您没有根据实际的代码制定决策，那么您可能就要面临随之而来的很多问题。您可以在构建过程中生成图示，并

9、建立一个持续集成（ContinuousIntegration，CI）环境来即时地（或定期地）创建图示。这样您就能够制作出有益于决策、易于创建且始终反映最新情况的图示了。清单1使用Ant、UMLGraph以及Graphviz对源代码进行文档化:清单1.使用UMLGraph文档化工具的Ant脚本