ActionScript3代码注释规范.doc

ActionScript3代码注释规范说明：1、此注释有利于使用asDoc工具生成API文档。2、在FB中，按Ctrl + Shift + D生成注释符。3、“*”号与注释文字间保留一个空隔符。一、 如何创建比较完善的API文档1) 只有包含在/*与*/之间的注释才能被asDoc识别。2) 注释的第一行开始（不包括注释标记）是被注释对象（方法、属性等）的说明介绍。当出现注释标记的时候，asDoc就会自动解析为相应的内容。3) 常用的asDoc注释标记：a) eventType：只能用于注释Event元标记，如Event(name=init, type=flash.events.Event)。这样在API文档中这个事件会出现这个类的Event说明块中。b) example：用于创建一个示例。示例代码需写在和之间。c) see：用于创建“另请参见”说明块。d) default：用于创建属性的“默认值”说明。e) param：用于创建对方法的参数的说明。f) return：用于创建对方法的返回值的说明。g) private：使用此标记的方法或属性将不会输出到API文档中。二、 事件注释/* * 事件描述说明 * eventType 完整的事件类型 */例子：/* * 当创建一个Map实例的时候调度init事件。 * eventType mx.events.FlexEvent.BUTTON_DOWN */Event(name=init, type=flash.events.Event)三、 变量注释/* 变量描述说明* default 默认值说明 */例子：/* * 创建者 * default EPGIS */public var creator:String;四、 类注释/* * 类描述说明。 * example * * 例子代码 * * see 网址或描述，可留空 */例子：/* * EPGIS API for Flex的主类。展示地图实例。 * example * * var map:Map=new Map(); * map.print(MAP主类); * map.test(EPGIS); * * see */public class Map五、 属性注释在get中添加注释即可/* 属性描述说明* return */例子：/* * 启用或禁止按住Shift钮并单击返回地图中心点位置的值 * return */public function get clickRecenterEnabled():Booleanreturn this._clickRecenterEnabled;public function set clickRecenterEnabled(value:Boolean):voidthis._clickRecenterEnabled = value;六、 构造注释/* 构造函数描述说明 */例子：/* * 构造函数 */public function Map()七、 方法注释/* 方