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
相关文档:
(注:采用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 ......
flex中在DisplayObject里直接用stage,可能会是null,原因不是太清楚,找到了解决办法,当接收到ADDED_TO_STAGE事件时,stage肯定被创建出来了,这个时候再使用就没有问题。
addEventListener( Event.ADDED_TO_STAGE, function( e:Event ):void ??
{
stage.addEventListener(KeyboardEvent.KEY_DO ......
Adobe Flex开发与传统的Web开发有很多不同之处。正确的理解和利用这些不同之处,可以帮助我们创建更丰富的用户体验,也可以反过来增加网站的可用性以及浏览和更新速度。Flex还提供了大量的组件和技术库来让Web开发更加轻松——它提供的强大工具要远远超过传统Web 2.0中的异步JavaScript和XML(Ajax)应用。此外, ......
用过FLEX中String类型的朋友可能知道,replace这个方法并不过替换所有内容。那么我们需要替换所有内容怎么办?只有自己动手,丰衣足食咯,呵呵。言归正专,有两种方法,一种是利用Array的方式,另一种是利用正则去替换。
/**
* StringReplaceAll
* @param source:String 源数据
* @param find:String 替换对象 ......