Flex SDK 4(Gumbo)浅析ASDoc ASDoc Tags参数
《Flex SDK 4(Gumbo)浅析ASDoc - Flash Builder 4配置篇》介绍了如何在Flash Builder 4里面配置、运行ASDoc。
本篇文章介绍一些比较常用的ASDoc Tags,只有搞清楚了如何使用ASDoc Tags才能让我们生成一些我们想要的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.html
相关文档:
现在flash builder 4已经自带了多种语言包,在使用的时候直接拿过来用就可以了,在使用资源文件的时候,需要设置一下资源参数
-locale=en_US,zh_CN -source-path=locale/{locale}
flex 3.x的版本的sdk只支持英文和日文,如果需要中文,则可以从flex
4.xsdk的\frameworks\locale拷贝zh_CN等文件夹到flex3.x的\frameworks ......
(注:采用fb4 beta1开发,由于兼容问题,可以适当加以修改放到自己的环境中,测试的时候需要放到服务器上面,本人的测试url为
http://127.0.0.1/astest/asjs.html?msnum=13112345678)
mxml文件:
<?xml version="1.0" encoding="utf-8"?>
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" creation ......
最终我决定还是用“隐藏”这个不是很合适的词。mx_internal是一个自定义命名空间,至于“命名空间”到底是什么就不在这里说了。总之,当我们在代码头部写上:
use namespace mx_internal
(如果是.AS文件,需要手动import mx.core.mx_internal,注意这个不会有代码提示)
那么所有以mx_internal为命 ......
使用flex tree 和list实现如下选择用户的效果
<?xml version="1.0" encoding="utf-8"?>
<mx:TitleWindow xmlns:mx="http://www.adobe.com/2006/mxml" layout="vertical"
showCloseButton="true" creationComplete ......