如何使用ASDoc注释代码
ASDoc是非常强大的工具,可以将你的代码中的注释抽取出来作为一个参考手册,这就要求你写代码注释的时候,要按照ASDoc要求的格式来写,那么,需要注意哪些地方呢?ASDoc有哪些书写的规范呢?
首先,使用/** */的方式包含注释,一段典型的ASDoc写法应该如下:
/**
* Main comment text.
*@author Jerry
*/
注意,可以使用HTML语法,比如:
<p><b>这是加粗字体</b><i>这是倾斜字体</i></p>
特殊标注,上面的@author指作者,还有以下的:
@param param1 xxxxxx 这是用于说明方法的参数
@return 用于说明返回值
@see 其它的参考方法
@private 这个标签定义的内容将不会被输出到文档
更多的标签说明,参见:
http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff6.html

.gif)
.gif)




.gif)
发表新评论