javascript代码注释规范

文件注释

/*
概要说明及版本（必须）项目地址（开源组件必须）版权声明（必须）开源协议（开源组件必须）
版本号（必须）修改时间（必须），以ISO格式表示（可使用Sublime Text的InsertDate插件插入）
文件注释必须全部以英文字符表示，并存在于文件的开发版本与生产版本中。
*/

/*!
 * QQmmPlugins Javascript Library
 * waterfall - v1.0.0 (2020-10-15T14:55:51+0800)
 * http://www.willyleung.top/ | Released under MIT license
 * Copyright 2010-2020 56.com
 * 
 * Include sizzle (http://sizzlejs.com/)
 */
 

普通注释

// this is comment

/*
here is line 1
here is line 2
*/

函数注释

/**
 * @function 简单说明
 * @description 详细描述
 * @param {number} c 参数说明
 * @param {number} o 参数说明
 * @return {number}
 * @author QQmm 2022/08/05
 * @version 1.0
 * @example 
 */

类（属性、方法）注释

/**
 * 人物定义类
 * @class Person
 * @classdesc 这是类的描述
 * @constructor
 * @param {String} firstName 名字
 * @param {String} lastName 姓氏
 */
class Person {
    /**
     * @type {number} [age = 18] - 年龄
     */
    age = 18;
    constructor(firstName, lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    /**
     * @memberOf Person
     * @method intro
     * @param {String} country - 国家 e.g 'China'
     * @return {string} 全名
     */
    intro (country) {
        return `My name is ${this.firstName} ${this.lastName}, I'm come from ${country} and ${this.age} years old.`;
    }
}