ActionScript中使用注释规范及ASDoc命令参数小结

Categories: Flex; Tagged with: ActionScript • ASDoc • Flex; @ October 24th, 2008 1:27

在没有使用ASDoc之前, 我的注释总是乱七八糟, 并且胡说八道. 该讲的没有讲清楚, 废话比代码还多. 自从抱着试试看的态度用了一下ASDoc, 俺决定认真参照公司的代码规范, 认真规范下俺不曾被规范的注释.

ActionScript注释生成工具很多, 但俺们就使用ASDoc.

首先, 总结下ActionScript注释规范:

常用的注释:
@param
@return
@throws
@see
如:

	/**
	 * 解析给定的I18N语言字符串, 并通过fieldStringToLocalizationItem将之转换为LocalizationItem对象,放入到ArrayCollection中.
	 * @example 处理里一串I18N语言字符串
	 *
	 * stringToAC('{zh=简体中文}{zh_tw="繁体中文"}', false);
	 * 
	 * @param s:String 待处理的字符串
	 * @param strict:Boolean 是否采用严格机制来处理, 默认为ture,意为如果字符串不合要求则报错; 可指定为False, 忽略错误,完成操作.
	 * @return 处理完后包含有LocalizationItem的ArrayCollection; 如果制定的字串为NULL,则返回一个空的ArrayCollection;
	 * @throws Error 如果strict为true,在检测到字符串不合要求时会throw Error.
	 * @see #fieldStringToLocalizationItem()
	 */
	public static function stringToLocalizationItems(s:String, strict:Boolean = true):ArrayCollection {
....
}

[这个文档写的很粗糙] 经过ASDoc生成后的文档如下:

@see的用法

当需要see顶级类中的函数时
@see Array#pop(); (Method)
@see Array#length; (Property)

需要see本类某函数时,如需要see下本类的 fieldStringToLocalizationItem(fieldString:String, strict:Boolean = true)函数, 则:
@see #fieldStringToLocalizationItem().

关于@see的详细介绍: http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_7.html#188433
不足之处就是开发工具对注释的支持实在是不敢恭维.

另外总结下ASDoc里重要的配置参数

-source-path, 该path指明了源代码存放的位置

-doc-classes, 需要生成目录的类 , 在使用该变量之前必须已经声明-source-path;

如: asdoc -source-path . -doc-classes comps.GraphingWidget comps.GraphingWidgetTwo 则意味着生成当前目录下,comps\GraphingWidget .as 与comps\GraphingWidgetTwo.as的文档

-doc-sources: 指定某目录, 生成该目录及其子目录下所有.as文件的注释. 可以单独直接使用,也可以配合使用-source-path. 如:

doc-sources E:\\eclipse-jee-europa-fall2-win32_FB3\\eclipse\\workspace\\AIRTest\\com\\insprise

或配合使用:

-doc-sources com\\insprise

-source-path E:\\eclipse-jee-europa-fall2-win32_FB3\\eclipse\\workspace\\AIRTest\\com\\insprise

其他信息基本上都是无关紧要不痛不痒的一看明白.

可参照:http://liguoliang.com/2008/10/280/

通过ANT与ASDoc生成Flex文档 <-> FlexUnit使用 Useing FlexUnit