Javascript的注释规范

注释的条件

• a.文档的注释
• b.函数(类)规范
• c.变量（常量）规范

常用关键词

关键词	说明
@auhor	作者
@param	参数
@example	示例
@version	版本号
@return	返回值

 

举例：

a.文档的说明

/**
* 该文档主要完成主要任务是……
* @author Zero||One 
* @version 1.0.0
*/

 

b.函数(类)规范/**

 * 数据格式化
 * @param id {Number}        长度自由的一维数组，子元素为json对象
 * @param name {String}      参考数据，........................................................
 *                           文字不够换号来补........................
 *                           文字不够换行来补........

 * @return result {Array}    返回格式化后与src类型相同的数组
 */

functon Test(){
    ....
}

 

c.变量（常量）规范

//标题
var title = "标题";
//描述
var descript = "描述";