一、FlashBuilder生成方法:
具体设置请看截图:
1.选择“外部工具配置”
2. 新建一个外部配置
3.编辑外部配置:
位置:填写asdoc.exe的路径,也可通过“浏览文件系统”找到对应文件
工作目录:选择你需要生成的asdoc的项目中的目录
自变量:-source-path . (这里的“点号”代表本目录中) -doc-sources .\main (这里是填写需要生成asdoc的文件目录或文件)
-external-library-path "D:\**\aa.swc" (这里是填写额外的类库路径)
4.至此,asDoc的外部配置已经完成,现在可以点击“运行”生成doc文件了。
当配置完毕后,点击运行,如果没有ASDoc语法错误的话,就会在Flash Builder 4的控制台上面打印如下的内容。
Loading configuration file I:\Program Files\Adobe\Flash Builder Beta\sdks\4.0.0\frameworks\flex-config.xml
Documentation was created in E:\04-Flex\01-work\Flex4\KUI\src\asdoc-output\
二、FlashDevelop生成方法:
1.打开工具->Flash工具->Documentation Genaerator...选项
2.填写必要的参数
Page title: 页面标题,通常与项目名称相同
Output directory: doc输出路径
Classpaths:需要生成doc的类路径,可通过右侧"Browse"选择出。
Extra options:额外参数,如果需要swc类库,需要添加参数 -external-library-path "类库路径名\*.swc"
Copliler:编译语言,需要编译的是as2还是as3。
----以上参数设置好后,点击"Generate"按钮,开始生成doc文档
3.可切换到Output选项卡中,查看生成的状态。
三、asDoc 标签的使用
具体请参看:http://hi.baidu.com/vim888/blog/item/f8cbd812f08ab8c5c2fd7839.html
四、一个例子文件
package test
{
import flash.display.Sprite;
public class tt1 extends Sprite {
/
public function setSize(w:int, h:int=0):int {
return 0;
}
public function setTxtFormat(size:int, color:uint, font:String = "Arial"):void{
}
//------------------------------set|get funs----------------------------------
public function get size():int { return _size; }
public function set size(value:int):void {
_size = value;
}
}
}
该文件生成的doc截图如下:
分享到:
相关推荐
这篇博客“终于成功使用asdoc生成了文档”可能详细记录了博主在使用asdoc过程中遇到的问题及解决方案,虽然具体的博客内容未给出,但我们可以基于asdoc的基本用法和常见问题来探讨相关知识点。 首先,asdoc是...
### ASDoc生成ActionScript的API类文档 #### 一、简介 随着软件项目的规模逐渐增大,维护和协作的需求也日益凸显。为此,编写详细的API文档成为了一项必不可少的任务。Adobe官方提供了一个强大的工具——ASDoc,它...
Flash-Builder-里利用ASDOC生成在线API文档配置.doc
2. 文档注释:为了使ASDoc生成的文档更丰富,开发者应在ActionScript代码中添加详细的类、方法和属性注释。这些注释使用特殊的 ASDoc 注释语法,如`@param`, `@return`, `@event`等,它们将直接出现在生成的文档中。...
当使用ASDoc生成文档时,这段注释将出现在生成的文档中,方便其他开发者了解`print`方法的用途及其参数的意义。 #### 五、命令行参数详解 - `-doc-classes`: 指定需要生成文档的类。 - `-doc-namespaces`: 指定...
在AsDocLib这个压缩包中,可能包含了一个示例的Flex库项目,以及运行AsDoc生成文档所需的所有源代码和配置。解压后,你可以根据提供的说明或作者的博客文章,学习如何使用AsDoc来为自己的Flex库生成API文档。 **...
1. ASDoc配置文件:定义了ASDoc生成文档时的参数,如输出目录、样式表、排除的类或包等。 2. AS3源代码:包含了Adobe官方的AS3 API实现,这些源码被ASDoc解析以生成文档。 3. 脚本或批处理文件:可能包含运行ASDoc...
3. **ASDoc**:ActionScript Doc的缩写,它是一个命令行工具,能够从ActionScript源代码中的注释生成文档。ASDoc生成的文档格式为HTML,方便开发者查阅和理解代码结构及功能。ASDoc注释使用特殊的语法,类似于Java的...
2. `@private`:此标签指示ASDoc在生成文档时不应包含该类或元素。它用于隐藏内部实现细节,只对项目内的开发者可见。 3. `@return description`:用于描述函数或方法的返回值。ASDoc会自动推断返回值的数据类型,...
ASDoc使用ANT(Another Neat Tool)脚本语言,通过命令行的方式来生成文档,因此在配置这些参数时需要遵循ANT的语法规则。 2. 设置文档的语言编码。为了支持中文注释,需要将文档的编码设置为UTF-8,这是国际标准的...
咕as声一个Grunt任务插件,用于为Adobe Flex / ActionScript / MXML / FLV / etc生成文档。 Apache / Adobe Flex SDK中带有asdoc工具的应用程序。入门这个插件需要~0.4.2 如果您以前从未使用过 ,请务必查看...
ASDoc 是 Adobe 引入的一种文档生成工具,用于创建 ActionScript 项目的 API 文档。它通过解析源代码中的特殊注释(即 ASDoc 标签)来生成详细、易读的文档。以下是一些主要的 ASDoc 标签及其用法: 1. `@param ...
4. 使用ASDoc生成API文档:便于团队协作和后期维护。 5. 测试和调试:使用Flex SDK内置的模拟器和调试器进行测试和问题排查。 **标签“flex4”** Flex 4是Flex框架的一个重大更新,引入了Spark组件架构,提供更高...
要生成文档,请从项目报告中的 Adobe AIR SDK 安装执行 asdoc,例如: ~/sdk/AIRSDK_15.0.0.356/bin/asdoc \ -doc-sources . \ -output asdoc 执照 该项目是下的免费开源软件。 版权所有 2010-20
- ASDoc的使用:学习如何通过ASDoc生成清晰的ActionScript API文档,以便于团队成员之间交流和后续的代码维护。 - 自动化工具:掌握如何利用自动化工具提升开发效率,例如代码格式化、代码检查和构建工具。 - 版本...
ASDoc生成的文档通常包括类的描述、方法、属性等详细信息,对于开源项目或者大型团队来说,是必不可少的文档资源。 5. 插件的安装与配置: 安装Flash Builder 4.5的插件通常通过Eclipse Marketplace或直接下载插件...
此外,FlexASDocGenCommand_0.9.0.jar可能涉及的是ASDoc生成功能,ASDoc是ActionScript的文档生成工具,能够自动生成API文档,帮助开发者理解代码结构和功能。这个插件可能扩展了原有的ASDoc功能,使其与格式化插件...
这个插件可能是将ASDoc功能集成到FlashBuilder中的扩展,允许开发者快速、方便地为自己的代码生成文档,提高代码的可读性和可维护性。 4. **org.sf.easyexplore_1.0.4.jar**:这个名字暗示这可能是一个文件和资源的...
这个版本可能是针对Flex项目的ASDoc生成器,可以帮助开发者自动生成清晰的API文档,方便团队协作和后期维护。 4. Readme.txt:这是一个重要的文件,通常包含安装和使用工具的说明。在这个场景下,安装Flex格式化...