actionscript3代码注释规范

《actionscript3代码注释规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、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.even

2、ts.Event")]。这样在API文档中这个事件会出现这个类的Event说明块中。b)@example：用于创建一个示例。示例代码需写在

3、件。*@eventTypemx.events.FlexEvent.BUTTON_DOWN*/[Event(name="init",type="flash.events.Event")]一、变量注释/***变量描述说明*@default默认值说明*/例子：/***创建者*@defaultEPGIS*/publicvarcreator:String;二、类注释/***类描述说明。*@example**例子代码**@see网址或描述，可留空*/例子：/***EPGISAPIforFlex的主类。展示地图实例

4、。*@example**varmap:Map=newMap();*map.print("MAP主类");*map.test("EPGIS");**@seehttp://www.epgis.com.cn*/publicclassMap{}一、属性注释在get中添加注释即可/***属性描述说明*@return*/例子：/***启用或禁止按住Shift钮并单击返回地图中心点位置的值*@return*/publicfunctiongetclickRecenterEnabled():Boolean{return

5、this._clickRecenterEnabled;}publicfunctionsetclickRecenterEnabled(value:Boolean):void{this._clickRecenterEnabled=value;}一、构造注释/***构造函数描述说明*/例子：/***构造函数*/publicfunctionMap(){}二、方法注释/***方法描述说明*@return返回值说明*/例子：/***缩小地图*/publicfunctionzoomOut():void{}