ASDoc tag
Description
Example
@copy reference |
Copies an ASDoc comment from the referenced location. The main description, @param, and @return content is copied; other tags are not copied.
You typically use the @copy tag to copy information from a source class or interface not in the inheritance list of the destination class. If the source class or interface is in the inheritance list, use the @inheritDoc tag instead.
You can add content to the ASDoc comment before the @copy tag.
Specify the location by using the same syntax as you do for the @see tag. For more information, see Using the @see tag.
|
@copy #stop
@copy MovieClip#stop
|
@default value |
Specifies the default value for a property, style, or effect. The ASDoc tool automatically creates a sentence in the following form when it encounters an @defaulttag:
The default value is value.
|
@default 0xCCCCCC |
@eventType package.class.CONSTANT@eventType String
|
Use the first form in a comment for an [Event] metadata tag. It specifies the constant that defines the value of the Event.type property of the event object associated with the event. The ASDoc tool copies the description of the event constant to the referencing class.
Use the second form in the comment for the constant definition. It specifies the name of the event associated with the constant. If the tag is omitted, ASDoc cannot copy the constant's comment to a referencing class.
|
See Documenting effects, events, and styles
|
@example exampleText |
Applies style properties, generates a heading, and puts the code example in the correct location. Enclose the code in <listing version="3.0"></listing> tags.
Whitespace formatting is preserved and the code is displayed in a gray, horizontally scrolling box.
|
@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>
|
@exampleText string |
Use this tag in an ASDoc comment in an external example file that is referenced by the@example tag. The ASDoc comment must precede the first line of the example, or follow the last line of the example. External example files support one comment before and one comment after example code. |
/** * This text does not appear * in the output. * @exampleText But this does.*/
|
@inheritDoc |
Use this tag in the comment of an overridden method or property. It copies the comment from the superclass into the subclass, or from an interface implemented by the subclass. The main ASDoc comment, @param, and @return content are copied; other tags are not. You can add content to the comment before the @inheritDoc tag. When you include this tag, ASdoc uses the following search order: 1. Interfaces implemented by the current class (in no particular order) and all of their base-interfaces. 2. Immediate superclass of current class. 3. Interfaces of immediate superclass and all of their base-interfaces. 4. Repeat steps 2 and 3 until the Object class is reached. You can also use the @copy tag, but the @copy tag is for copying information from a source class or interface that is not in the inheritance chain of the subclass. |
@inheritDoc |
@internal text |
Hides the text attached to the tag in the generated output. The hidden text can be used for internal comments. |
@internal Please do not publicize the undocumented use of the third parameter in this method. |
@param paramName description |
Adds a descriptive comment to a method parameter. The paramName argument must match a parameter definition in the method signature. |
@param fileName The name of the file to load. |
@private |
Exclude the element from the generated output. To omit an entire class, put the @private tag in the ASDoc comment for the class; to omit a single class element, put the @private tag in the ASDoc comment for the element. |
@private |
@return description |
Adds a Returns section to a method description with the specified text. ASDoc automatically determines the data type of the return value. |
@return The translated message. |
@see reference [displayText] |
Adds a See Also heading with a link to a class element. For more information, see Using the @see tag. Do not include HTML formatting characters in the arguments to the @see tag. |
@see flash.display.MovieClip |
@throws package.class.className description |
Documents an error that a method can throw. |
@throws SecurityError Local untrusted SWFs may not communicate with the Internet. |
相关推荐
此文档主要是用于讲述ASDoc中各种标签的作用,文档中附有详细的说明和插图能够让您更加容易理解。
教案ASDoc标签材料.pdf
ASDoc标签知识点.pdf
asdoc.zip flex
ASDoc生成ActionScript的API类文档 ASDoc生成ActionScript的API类文档 ASDoc生成ActionScript的API类文档
Flex Library AsDoc Demo 查看我的博客<Flex AsDoc 完整版>,有详细的Flex Library AsDoc说明
Flash-Builder-里利用ASDOC生成在线API文档配置.doc
NULL 博文链接:https://damoqiongqiu.iteye.com/blog/1481207
以flexbuilder为例,在你安装的目录下X:\Program Files\Adobe\Flex Builder 3\sdks\3.2.0\asdoc\templates。改文件夹就是控制稳定框架本地化的。你只要办里面的相关文字翻译为中文就可以了。关联文件就是xsl格式的...
sina-microblog-api-asdoc-rc.zip
java运行依赖jar包
Apache / Adobe Flex SDK中带有asdoc工具的应用程序。入门这个插件需要~0.4.2 如果您以前从未使用过 ,请务必查看《指南》,因为它说明了如何创建以及安装和使用Grunt插件。 熟悉该过程后,可以使用以下命令...
Flex Realspace产品在sp3时上线,急需制作帮助文档,由于在开发的时候没有考虑后期的帮助文档,查了很多资料,希望通过ASDoc达成愿望,感兴趣的朋友可以了解下,或许对你有所帮助
操作步骤共分六步,每个步骤都有具体的若干条Stata指令,带有命令注释 ,极易看懂。步骤如下: 第一步:安装程序包 第二步:打开权重文件 第三步:打开数据文件 第四步:计算全局莫兰指数 第五步:计算局部...
3.2 悬停时的ASDOC提示 3.3 Getter & Setter 3.4 自动生成EventHandler 3.5 条件断点 第四章 Flex SDK 4 新特性 4.1 主题 4.2 布局 4.3 特效 4.4 样式 4.5 状态 4.6 双向绑定 4.7 ASDoc 4.8 SWFObject ...
新增MXML标签 改进的视图状态 (1) 改进的视图状态 (2) MXML图形元素与FXG Spark组件架构 Spark容器 Spark布局模型 Spark动画和特效组件 Pixel Bender集成 Spark文本组件 双向数据绑定 高级CSS Selector ...
要生成文档,请从项目报告中的 Adobe AIR SDK 安装执行 asdoc,例如: ~/sdk/AIRSDK_15.0.0.356/bin/asdoc \ -doc-sources . \ -output asdoc 执照 该项目是下的免费开源软件。 版权所有 2010-20
FlexprettyPrintCommand:对代码进行格式化,生成 asdoc sourcemate3:简化人工操作
asdoc :对应于API的文档,它的首页是PureMVC_AS3_2_0_4/asdoc/index.html src:对应于puremvc的的源代码, PureMVC_AS3_2_0_4/src/org/puremvc/as3 / … bin:对应于Flex / AIR的的项目中使用的swc(在Flex4中安装...