25.10节. 使用ASDoc和Ant生成文档
25.10.1. 问题
我想为应用程序生成文档。
25.10.2. 解决办法
首先创建一个使用ASDoc（包含在Flex 3 SDK中）生成文档的Ant建造文件，然后为它添加一个可执行的任务。
25.10.3. 讨论
ASDoc是Flex 3 SDK中的一个免费的命令行工具。如果你看过Adobe的在线帮助文档，那么你已经熟悉了ASDoc生成的文档风格。虽然在命令提示符下使用它并不十分的困难，但是为你的Ant建造文件添加一个任务来自动化流程会更好一些。
在为生成文档创建目标之前，先添加一个清理你的文档目录的目标会非常有用。你定义docs.dir属性时，把它指向你的项目的docs目录就可以了：
完成上面的工作后，就要创建用来生成文档的目标了。注意，在本例中的depends属性表示在生成文档前会先执行cleanDocs：
FLEX_HOME属性应该指向你机器上的Flex 3 SDK的根目录。src.dir和doc.dir属性分别代表你的项目的src和docs目录。最后但并非不重要的是docs.title和docs.footer属性，它们用来设置文档的标题和底部。通常文档的标题是你的项目名称。底部是放置版权和URL的好地方。
即便你没有写任何注释，ASDoc会根据你的代码成功的生成文档。当然，强烈推荐按照Java文档注释的格式在你的代码中写上注释。这样不仅能生成详尽的文档，而且能帮助不熟悉你代码的开发者深入理解代码。
我想为应用程序生成文档。
25.10.2. 解决办法
首先创建一个使用ASDoc（包含在Flex 3 SDK中）生成文档的Ant建造文件，然后为它添加一个可执行的任务。
25.10.3. 讨论
ASDoc是Flex 3 SDK中的一个免费的命令行工具。如果你看过Adobe的在线帮助文档，那么你已经熟悉了ASDoc生成的文档风格。虽然在命令提示符下使用它并不十分的困难，但是为你的Ant建造文件添加一个任务来自动化流程会更好一些。
在为生成文档创建目标之前，先添加一个清理你的文档目录的目标会非常有用。你定义docs.dir属性时，把它指向你的项目的docs目录就可以了：
+展开
-XML
<!-- CLEAN DOCS -->
<target name="cleanDocs" description="Cleans out the documentation directory.">
<echo>Cleaning '${docs.dir}'...</echo>
<delete includeemptydirs="true">
<fileset dir="${docs.dir}" includes="**/*" />
</delete>
</target>
<target name="cleanDocs" description="Cleans out the documentation directory.">
<echo>Cleaning '${docs.dir}'...</echo>
<delete includeemptydirs="true">
<fileset dir="${docs.dir}" includes="**/*" />
</delete>
</target>
完成上面的工作后，就要创建用来生成文档的目标了。注意，在本例中的depends属性表示在生成文档前会先执行cleanDocs：
+展开
-XML
<!-- GENERATE DOCUMENTATION -->
<target name="generateDocs" description="Generates application documentation using ASD
oc." depends="cleanDocs">
<echo>Generating documentation...</echo>
<exec executable="${FLEX_HOME}/bin/asdoc.exe" failOnError="true">
<arg line="-source-path ${src.dir}" />
<arg line="-doc-sources ${src.dir}" />
<arg line="-main-title ${docs.title}" />
<arg line="-window-title ${docs.title}" />
<arg line="-footer ${docs.footer}" />
<arg line="-output ${docs.dir}" />
</exec>
</target>
<target name="generateDocs" description="Generates application documentation using ASD
oc." depends="cleanDocs">
<echo>Generating documentation...</echo>
<exec executable="${FLEX_HOME}/bin/asdoc.exe" failOnError="true">
<arg line="-source-path ${src.dir}" />
<arg line="-doc-sources ${src.dir}" />
<arg line="-main-title ${docs.title}" />
<arg line="-window-title ${docs.title}" />
<arg line="-footer ${docs.footer}" />
<arg line="-output ${docs.dir}" />
</exec>
</target>
FLEX_HOME属性应该指向你机器上的Flex 3 SDK的根目录。src.dir和doc.dir属性分别代表你的项目的src和docs目录。最后但并非不重要的是docs.title和docs.footer属性，它们用来设置文档的标题和底部。通常文档的标题是你的项目名称。底部是放置版权和URL的好地方。
即便你没有写任何注释，ASDoc会根据你的代码成功的生成文档。当然，强烈推荐按照Java文档注释的格式在你的代码中写上注释。这样不仅能生成详尽的文档，而且能帮助不熟悉你代码的开发者深入理解代码。
加支付宝好友偷能量挖...
