=波波日志 > flash/flex/fcs/AIR > 25.10节. 使用ASDoc和Ant生成文档=
[转]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文档注释的格式在你的代码中写上注释。这样不仅能生成详尽的文档,而且能帮助不熟悉你代码的开发者深入理解代码。
类别:flash/flex/fcs/AIR 作者:转载 日期:2010-04-29 【评论:0】
暂时没有评论!
发表留言
百度赞助
同类热门博文
- ·As+lightbox+js实现..
- ·21.8.使用Cairngorm..
- ·13.1.为ArrayCollec..
- ·18.13.通过二进制So..
- ·22.7.使用ModuleLoa..
- ·JavaScript控制Flas..
- ·6.6.动态载入外部图..
- ·flash预加载进度条p..
博格Tag
- flash/flex/fcs/AIR(752)
- Asp.Net/C#/WCF(601)
- 操作系统及应用软件(377)
- JavaScript/Ajax(331)
- SQL及数据库(135)
- 黑客技术(115)
- Asp/VBScript(111)
- HTML/WML/CSS兼容/XML(102)
- PHP/apache/Perl(96)
- 网站排名及优化(96)
- 其他(75)
- showbo日志(66)
- lucene.net/分词技术(33)
- 计算机网络(26)
- C#设计模式(26)
- 机械重工(26)
- Google Maps开发(17)
- 日语学习(15)
- Canvas/VML/SVG(13)
- linux(11)
- 游戏开发(8)
- 正则表达式(5)
- Jsp/Java(4)
最新博文
- ·PHP socket套接字学..
- ·Warning Cannot sen..
- ·php与flash as3 soc..
- ·Flash XMLSocket使用..
- ·给flash右键增加自定..
- ·flash控件html及col..
- ·Flash加载XML文件CD..
- ·Flex3中文教程--hom..
随机博文
