ASDoc 标签 | 描述 | 实例 |
@param paramName description | 为函数的参数添加注释。 属性名与函数中的参数名必须匹配 | @param fileName The name of the file to load. |
@private | 输出时会被排除的元素. | @private |
@return description | 为函数的返回值添加描述信息 | @return The translated message. |
@see reference [displayText] | 用@see标签可以增加插入‘参见更多’的一个链接. 更多信息参见 Using the @see tag. | @see flash.display.MovieClip |
@throws package.class.className description | 输出函数能throw的错误 | @throws SecurityError Local untrusted SWFs may not communicate with the Internet. |
@copy reference | 从当前文章中拷贝ASDoc命令。 可拷贝@param标签和@return标签的内容,其它标签不可用. 也可以用@copy标签父类或父接口源文件拷贝信息. 如果父类或父接口被继承,用@inheritDoc标签代替 也可以在@copy标签之前添加内容 @see标签也可以用同样的句法 指定位置。 | @copy #stop @copy MovieClip#stop |
@default value | 为 property, style或 effect指定默认值. 当ASDoc检测到@default标签后会自动创建:The default value is value. | @default 0xCCCCCC |
@example exampleText | 在指定位置的头部添加可自定义样式属性的代码实例 | @example The following code sets the volume level for your sound: |
@exampleText string | 在ASDoc命令中使用该标签 会将@example标签中的内容放在一个附加文件中. 该命令必须写在实例代码前或之后 | /** |
@inheritDoc | 用该标签解释重写的方法或属性. 可以从父类或父接口中把注释拷贝到子类中 @param和@return标签 注释内容能被拷贝,其它标签不可以。也可以在@inheritDoc 使用该标签后ASdoc会有一下: | @inheritDoc |
@internal text | 在输出的文档中会被隐藏的内容内容. 但在类文件源代码中可以看到 | @internal Please do not publicize the undocumented use of the third parameter in this method. |
原文地址:http://bbs.actionscript3.cn/viewthread.php?tid=9590