学习目标
学会如何使用ASDoc生成我们的控件说明书
实现步骤
ASDoc一款用于生成代码说明书的工具，他能自动将我们书写在程序中的注释转换为说明书中控件属性，方法等的说明。所以如果我们非常规范的书写了自定义控件的注释，在最后我们可以通过一个简单的命令生成一本控件的说明书。
在Flex 3中ASDoc只能完美的生成ActionScript控件的说明书，而对MXML控件只对<scripit>中的注释有效。在Flex 4中，ASDoc已经能完美生成MXML控件的说明。我们现在就通过一个例子学习如何使用ASDoc
任意创建一个Flex项目，之后新建一个名为MyVBoxComplex.mxml的文件，拷贝下面的代码到文件中
<?xml version="1.0"?>
<!-- MyVBoxComplex.mxml -->
<!---
The class level comment for the component.
This tag supports all ASDoc tags,
and does not require a CDATA block.
-->
<mx:VBox xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:mx="library://ns.adobe.com/flex/halo"
xmlns:s="library://ns.adobe.com/flex/spark">
<!---
Comment for language element - this comment will be ignored.
-->
<fx:Script>
<![CDATA[
import flash.events.MouseEvent;
/**
* For a method in an <Script> block,
* same rules as in an AS file.
*
* @param eventObj The event object.
*/
public function handleClickEvent(eventObj:MouseEvent):void {
dispatchEvent(eventObj);
}
/**
* For a property in an <Script> block,
* same rules as in an AS file.
*/
public var myString:String = new String();
]]>
</fx:Script>
<!---
Comment for first button appears in the output.
-->
<s:Button id="myButton" label="This button has a comment"
click="handleClickEvent(event);"/>
<s:Button id="myButton2"
label="Has id but no comment so appears in output"/>
<!---
Comment for button with no id is ignored by ASDoc.
-->
<s:Button label="This button has no id"/>
</mx:VBox>
asdoc命令存在于"FlashBuilder4安装目录/sdks/4.0.0/bin"
我们现在通过asdoc在bin目录下创建document文件夹并在其中生成上面MyVBoxComplex的说明书。进入bin目录，在命令行中输入下面命令。我的命令是在Mac下运行的，所以我的MyVboxComplex.mxml路径是linux格式，Windows下的同学直接输入windows路径代替即可，比如C:\flex\projects\demo\src\mx\controls\MyVBoxComplex.mxml
asdoc -doc-sources ~/Documents/Adobe\ Flash\ Builder\ Beta/ASDocDemo/src/MyVBoxComplex.mxml -output document
生成的文件列表见“图五十二”；双击index.html，看到的页面见"图五十三"。
图五十二
ASDoc生成列表
图五十三
ASDoc生成列表
同学们可以清楚看到MyVBoxComplex的说明页面。
ASDoc的简单介绍就到这里，目的是让大家通过这个例子对ASDoc有一定的了解。ASDoc细讲起来有很多内容，这里就不详述了。感兴趣的同学可以在Flash Builder4的帮助文档中输入ASDoc查看详细说明
思考：
如何生成多个控件的说明？
哪些注释在ASDoc中会被忽略？