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
相关文档:
方法一:
<?xml version="1.0"?>
<!-- events/MultipleEventHandlersInline.mxml -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script><![CDATA[
private function submitForm(e:Event):void {
// Handle event here.
......
最终我决定还是用“隐藏”这个不是很合适的词。mx_internal是一个自定义命名空间,至于“命名空间”到底是什么就不在这里说了。总之,当我们在代码头部写上:
use namespace mx_internal
(如果是.AS文件,需要手动import mx.core.mx_internal,注意这个不会有代码提示)
那么所有以mx_internal为命 ......
不久前,Michael Portuesi发表了一篇博文,谈到了Flex开发者需要知道的10件事。文章介绍了每个进入Flex领域的开发者都需要掌握的基本知识与技能。
Michael Portuesi给出的10个条目中,有些是开发者需要了解的简单细节信息;有些则揭示了Flash/ActionScript/Flex与其他开发环境之间的差别。
如果你了解HTML/CSS并熟悉JavaS ......
Adobe Flex开发与传统的Web开发有很多不同之处。正确的理解和利用这些不同之处,可以帮助我们创建更丰富的用户体验,也可以反过来增加网站的可用性以及浏览和更新速度。Flex还提供了大量的组件和技术库来让Web开发更加轻松——它提供的强大工具要远远超过传统Web 2.0中的异步JavaScript和XML(Ajax)应用。此外, ......