25.10节. 使用ASDoc和Ant生成文档

2024-04-27 13:52:37

字体：大中小

来源：转载

供稿：网友

25.10.1. 问题
我想为应用程序生成文档。
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>