?ASDoc是adobe官方提供的ActionScript的API文档生成工具,现在已经集成在FlexBuilder中,使用方法如下;
1、首先配置一个生成文档需要的环境asdocapi,按照下面步骤
Run ->??External Tools -> External Tools Configurations
说明:
?1)、Location: 填asDoc.exe所在的路径?D:AdobeAdobe Flash Builder 4 Plug-insdks4.1.0binasdoc.exe
?????????? (sdk3.5是不能用的,不知道为什么)Error: '' is not a directory
?2)、Working Directory: 填工程中,代码所在的目录?${workspace_loc:/flexdoc/src}?
?3)、Arguments: AsDoc的编译参数?-source-path=. -doc-sources=${workspace_loc:/flexdoc/src}??-output="../FlexDoc"
??????? -external-library-path="D:workspaceflexdoclibs/framework.swc"?
下边两个都可以:
-source-path=. -doc-sources=${workspace_loc:/flexdoc/src}? -output="../../FlexDoc"
-source-path . -doc-sources=${workspace_loc:/flexdoc/src}? -output FlexDoc
--------------------??参数说明??----------------------?
????-source-path:代码所在的目录(不能用中文目录)?
????-doc-sources:文件所在的目录(不能用中文目录)?
????-output:?????????输出文档的目录(不能用中文目录)?
????-external-library-path:扩展的Lib路径(外部的swc的路径)(不能用中文目录)
2、为了AsDoc输出的文档支持中文的注释。
??????切换到Common选项卡,Console Encoding分组项目 -> 选择Other?-> 选择UTF-8?
3、Run ->??External Tools -> asdocapi
可能会报出一下的错误:
[Fatal Error] toplevel.xml:25186:244: The value of attribute "defaultValue" must not contain the '<' character.
Error: Could not create toplevel.xml: The value of attribute "defaultValue" must not contain the '<' character.
是因为你的注释某些地方文法有问题,比如标签有没有闭合,是不是用了一些特殊字符,比如><@等等。 SDK4.x本身没有错误,只是容错性比较差,出错提示也很烂,但是只要按规则写,就可以通过。