js注释规范

模块功能描述说明

/**
 * ------------------------------------------------------------------
 * 模块描述说明
 * ------------------------------------------------------------------
 */

模块内的小函数方法归类

/**
 * 小函数方法归类说明，这些零散的小函数方法放在一起 对应 一个业务方法逻辑
 * ------------------------------------------------------------------
 */

单个函数方法

/**
 * 函数功能简述
 *
 * 具体描述一些细节
 *
 * @param    {string}  address     地址
 * @param    {array}   com         商品数组
 * @param    {string}  pay_status  支付方式
 * @returns  void
 *
 * @date     2014-04-12
 * @author   QETHAN<qinbinyang@zuijiao.net>
 */

单行注释

//这是一条单行注释

单个函数方法中变量注释

//商品属性变量(一组变量描述)
    //商品名字(单个变量注释)
var name = $(item).find('.js-name').val(),
    //商品数量
    count = $(item).find('.js-count').text(),
    //商品单价
    price = $(item).find('.js-price').val();

单个函数方法中代码片段注释

/*
 | 代码片段的描述说明
 */

if, foreach, addEventListener … 这些代码片段的注释中缩进 必须使用空格。保证各种环境下排版的一致性。

总结

以上就是js注释规范要讲的内容

原文地址:https://developer.aliyun.com/article/443309