- 1、本文档共4页,可阅读全部内容。
- 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
ActionScript3代码注释规范
ActionScript3代码注释规范
说明:
1、此注释有利于使用asDoc工具生成API文档。
2、在FB中,按Ctrl + Shift + D生成注释符。
3、“*”号与注释文字间保留一个空隔符。
如何创建比较完善的API文档
只有包含在/**与*/之间的注释才能被asDoc识别。
注释的第一行开始(不包括注释标记)是被注释对象(方法、属性等)的说明介绍。当出现注释标记的时候,asDoc就会自动解析为相应的内容。
常用的asDoc注释标记:
@eventType:只能用于注释Event元标记,如[Event(name=init, type=flash.events.Event)]。这样在API文档中这个事件会出现这个类的Event说明块中。
@example:用于创建一个示例。示例代码需写在 listing 和 /listing 之间。
@see:用于创建“另请参见”说明块。
@default:用于创建属性的“默认值”说明。
@param:用于创建对方法的参数的说明。
@return:用于创建对方法的返回值的说明。
@private:使用此标记的方法或属性将不会输出到API文档中。
事件注释
例子:
变量注释
例子:
类注释
例子:
属性注释
在get中添加注释即可
例子:
构造注释
例子:
方法注释
例子:
/**
* 事件描述说明
* @eventType 完整的事件类型
*/
/**
* 当创建一个Map实例的时候调度init事件。
* @eventType mx.events.FlexEvent.BUTTON_DOWN
*/
[Event(name=init, type=flash.events.Event)]
/**
* 类描述说明。
* @example
* listing version=3.0
* 例子代码
* /listing
* @see 网址或描述,可留空
*/
/**
* EPGIS API for Flex的主类。展示地图实例。
* @example
* listing version=3.0
* var map:Map=new Map();
* map.print(MAP主类);
* map.test(EPGIS);
* /listing
* @see
*/
public class Map
{
}
/**
* 属性描述说明
* @return
*/
/**
* 构造函数
*/
public function Map()
{
}
/**
* 启用或禁止按住Shift钮并单击返回地图中心点位置的值
* @return
*/
public function get clickRecenterEnabled():Boolean
{
return this._clickRecenterEnabled;
}
public function set clickRecenterEnabled(value:Boolean):void
{
this._clickRecenterEnabled = value;
}
/**
* 构造函数描述说明
*/
/**
* 方法描述说明
* @return 返回值说明
*/
/**
* 缩小地图
*/
public function zoomOut():void
{
}
/**
* 变量描述说明
* @default 默认值说明
*/
/**
* 创建者
* @default EPGIS
*/
public var creator:String;
文档评论(0)