YUIDoc标签及使用方法

标签可用位置

文件

module

类

1. class
2. constructor // function Class(){}
3. param {Type} name 参数/[name=””]有默认值/[name]无默认值可选/…name 占位符 1-n/[…name]占位符 0-n
4. extends // 继承自那个类

类方法

1. method

2. private

3. protected

4. for // 指明 method, porperty, attribute, event 是属于那个类

5. param // 参数

6. async // 异步方法

7. chainable // 类方法返回值为 this 时使用

8. return // 返回值

9. static // 静态类/方法 Class.prototype.func 为非 static, Class.func 为 static

事件方法

1. event

2. for

3. param

4. bubbles

类属性

1. property // 类简单属性 string, number, boolean
2. type // 标记 property 和 attribute 的类型
3. final // 静态属性

其他标签

1. deprecated // 不推荐使用
2. since // 从哪个版本加入
3. beta // beta 版本
4. example // 例子

例子

文件头

/**
 * @filename ${NAME}
 *
 * @module Chat
 *
 * @author OnO<corn.mars@ono.lol>
 * @version 1
 * @time ${DATE} ${TIME}
 */

Handler 主函数

/**
 * Chat Handler
 *
 * @class ChatHandler
 * @param {Object} app
 * @constructor
 */

主函数属性

/**
 * App Instance
 *
 * @property app
 * @type {Object}
 */

类方法

/**
 * Send messages to users
 *
 * @method send
 * @for ChatHandler
 *
 * @param {Object} msg message from client
 * @param {Object} session
 * @param {Function} next next stemp callback
 *
 * @async
 * @return {Null}
 */

支持的所有标签

module
class
method
event
property

    extends
    constructor

    param

    static
    return
    for
    chainable
    async

    bubbles

    final
    type

    deprecated
    example
    since
    beta

main
element
attribute

    submodule
    namespace
    config
    readOnly
    writeOnce
    optional
    required
    throws
    private
    protected
    requires
    default
    uses
    parents
    contents
    interface
    extension
    extensionfor
    extension_for