Flash Builder ASDoc注释参数简介

在Flash Builder的ASDoc注释工具中经常会用到一下注释参数：

 

@author  --作者信息，似乎对@等特殊字符有屏蔽作用

@param  --函数参数信息，若有多个参数，可分行
@return  -- 函数返回类型描述
@throws --抛出异常描述信息
@see      --参见代码信息

 

需要注意的一个地方是@see,  当需要see某个类中的函数时

@see Array#pop();

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

@see #fieldStringToLocalizationItem() ；

 

以上列举的只是部分常用的注释参数，以后有机会可以补充。

 

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

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