jsdoc注释

listenWind

注释说明

  • 对象与方法的描述要突出重点,比如:一个正则表达属性,描述:XXX(作用)的正则表达式

    /**
    * 用于匹配输入框输入值的正则表达式
    */
    regex:"",
  • 文件头部用@module用来区分不同组件
  • 属性名用@member(表示@module的成员),不要用@property(表示一个对象 的属性,陈列在对象外边)
  • 函数参数部分写法:@param {type} [参数名] - 参数描述(其他类似)
  • 属性写明是@public还是@private(@private生成模板时可以不显示)
  • 如果属性只读,添加@readOnly
  • 如果属性必填,添加@required;
  • 如果函数参数是一个对象,对象属性值需要列举,在参数说明部分列举属性,并用<br>对每个属性换行(见下例)

下面是一个案例:

/**
 * ohaf-basic-search组件
 * 
 * @module ohaf-basic-search
 * @example
 * {{ohaf-basic-search placeholder='请输入文本' searchBtnText="搜索" ...}}
 */
export default Ember.Component.extend({
    /**
     * 文本框默认提示信息
     *
     * @member {string} placeholder
     * @default ""
     * @public
     */
    placeholder: "",

    /**
     * 是否支持enter键搜索事件
     *
     * @member {boolean} hasEnterSearch
     * @default true
     * @readOnly
     * @private
     */
    hasEnterSearch: true,

    /**
     * 搜索按钮显示文字
     *
     * @member {string} searchBtnText
     * @default "搜索"
     * @required
     * @public
     */
    searchBtnText: "搜索",

    /**
     * 构造函数描述
     * 
     * @constructs Book
     * @param {string} title 书本的标题.
     * @param {string} author  书本的作者.
     * @public
     */
    Book(title, author) {
        this.title=title;
        this.author=author;
    },

    /**
     * 参数是一个对象,需要列举对象属性
     * 
     * @method func
     * @param {object} data  name:搜索框输入值<br>
     *                       age:年龄<br>
     *                       country:国家
     * @return {object} 返回一个对象
     * @private
     */
    _func(obj) {
        return obj;
    },
    actions: {
        /**
         * 搜索事件
         *
         * @event onsearch
         * @param {(string|number)} value  -input的value值
         * @public
         */
        onClick(value) {
            if (this.get("searchable")) {
                this.sendAction('onSearch', value);
            }
        }

    }
});
阅读 4.6k
268 声望
2 粉丝
0 条评论
268 声望
2 粉丝
文章目录
宣传栏