ASDoc 的一些参数

ASDoc Tags@param paramName description
为函数的参数添加注释,如果有多个参数,则写入多个@param即可。
例如:@param scaleX 传入x轴方向的放大率@private
输出时会被排除的元素。(即
ASDoc不会解析和显示包含@private的内容)@return description
为函数的返回值添加描述信息。
例如:@return 累加的值@see reference [displayText]
用@see标签可以增加插入‘参见更多’的一个链接。
详细请看:
http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff8.html注意:@see标签中不能包含HTML格式化字符。
例如:@see com.rianote.flex.kui.component.LinkLabel@default value
某个变量的默认值
例如:
@default false
@default 0xffffff@example exampleText
在指定位置的头部添加可自定义样式属性的代码实例
代码需要写在<listing version="3.0"></listing>标签内
不规范样式时,实例代码会被先是在一个灰色可滚动的边框中
例如:
@example The following code sets the volume level for your sound:
<listing version="3.0">
var mySound:Sound = new Sound(); mySound.setVolume(VOL_HIGH);
</listing>@throws package.class.className description
对抛出的异常进行解释
例如:@throws SecurityError Local untrusted SWFs may not communicate with the Internet.@eventType description
对某一个Event类型进行描述
例如:@eventType mx.events.FlexEvent.BUTTON_DOWN关于ASDoc Tags的官方文档:
Flex SDK 4(Gumbo)官方ASDoc教程:http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff6.htmlFlex 3.x官方ASDoc教程:http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_9.html关于ASDoc中可以使用的HTML标签:http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-8000.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值