http://www.ibm.com/developerworks/cn/java/j-ap06108/
我曾遇到过一些拥有十分美观的 UML 图的项目 — 在项目的初始阶段。问题是,在某种特殊情况下,技术负责人无法使模型与源代码同步。或者需要将宝贵的时间浪费在将源代码手动 反向工程到模型中。这两种情况都不尽如人意。如果模型无法如实地展示签入到版本控制库中的代码,那么这个 UML 图构造的再美观也毫无意义。如果您没有根据实际的代码制定决策,那么您可能就要面临随之而来的很多问题。
您可以在构建过程中生成图示,并建立一个持续集成(Continuous Integration,CI)环境来即时地(或定期地)创建图示。这样您就能够制作出有益于决策、易于创建且始终反映最新情况的图示了。
清单 1 使用 Ant、UMLGraph 以及 Graphviz 对源代码进行文档化:
清单 1. 使用 UMLGraph 文档化工具的 Ant 脚本
<property name="reports.dir" value="${basedir}/reports"/>
<mkdir dir="${reports.dir}"/>
<path id="project.path">
<pathelement path="${basedir}/src"/>
<pathelement path="${basedir}/lib"/>
</path>
<javadoc sourcepath="${basedir}/src" destdir="${reports.dir}"
classpathref="project.path" access="private">
<doclet name="org.umlgraph.doclet.UmlGraphDoc"
path="UMLGraph.jar">
<param name="-attributes" />
<param name="-enumerations" />
<param name="-enumconstants" />
<param name="-operations" />
<param name="-qualify" />
<param name="-types" />
<param name="-visibility" />
</doclet>
</javadoc>
<apply executable="dot" dest="${reports.dir}" parallel="false">
<arg value="-Tpng"/>
<arg value="-o"/>
<targetfile/>
<srcfile/>
<fileset dir="${reports.dir}" includes="*.dot"/>
<mapper type="glob" from="*.dot" to="*.png"/>
</apply>
我曾遇到过一些拥有十分美观的 UML 图的项目 — 在项目的初始阶段。问题是,在某种特殊情况下,技术负责人无法使模型与源代码同步。或者需要将宝贵的时间浪费在将源代码手动 反向工程到模型中。这两种情况都不尽如人意。如果模型无法如实地展示签入到版本控制库中的代码,那么这个 UML 图构造的再美观也毫无意义。如果您没有根据实际的代码制定决策,那么您可能就要面临随之而来的很多问题。
您可以在构建过程中生成图示,并建立一个持续集成(Continuous Integration,CI)环境来即时地(或定期地)创建图示。这样您就能够制作出有益于决策、易于创建且始终反映最新情况的图示了。
清单 1 使用 Ant、UMLGraph 以及 Graphviz 对源代码进行文档化:
清单 1. 使用 UMLGraph 文档化工具的 Ant 脚本
<property name="reports.dir" value="${basedir}/reports"/>
<mkdir dir="${reports.dir}"/>
<path id="project.path">
<pathelement path="${basedir}/src"/>
<pathelement path="${basedir}/lib"/>
</path>
<javadoc sourcepath="${basedir}/src" destdir="${reports.dir}"
classpathref="project.path" access="private">
<doclet name="org.umlgraph.doclet.UmlGraphDoc"
path="UMLGraph.jar">
<param name="-attributes" />
<param name="-enumerations" />
<param name="-enumconstants" />
<param name="-operations" />
<param name="-qualify" />
<param name="-types" />
<param name="-visibility" />
</doclet>
</javadoc>
<apply executable="dot" dest="${reports.dir}" parallel="false">
<arg value="-Tpng"/>
<arg value="-o"/>
<targetfile/>
<srcfile/>
<fileset dir="${reports.dir}" includes="*.dot"/>
<mapper type="glob" from="*.dot" to="*.png"/>
</apply>