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 ... 这些代码片段的注释中缩进 必须使用空格。保证各种环境下排版的一致性。

 

 

 

 

 

 

 

 

 

 

 

 


目录
相关文章
|
6月前
|
JavaScript 前端开发 测试技术
JavaScript的基本规范
JavaScript的基本规范
|
6月前
|
分布式计算 JavaScript 前端开发
js手写面试题【附带注释】
js手写面试题【附带注释】
75 0
|
2月前
|
JSON JavaScript 前端开发
如何使用代码注释:关于JavaScript与TypeScript
TSDoc是一种标准化TypeScript代码文档注释的规范,使不同工具能无干扰地提取内容。它包括多种标记,如@alpha、@beta等发布阶段标记;@decorator、@deprecated等功能标记;@defaultValue、@eventProperty等描述标记;@example、@experimental等示例与实验性标记;@inheritDoc、@internal等引用与内部标记;@label、@link等链接标记;@override、@sealed等修饰符标记;以及@packageDocumentation、@param、
49 5
|
3月前
|
JavaScript 前端开发 程序员
JS小白请看!一招让你的面试成功率大大提高——规范代码
JS小白请看!一招让你的面试成功率大大提高——规范代码
|
5月前
|
JavaScript 前端开发
JavaScript 注释
JavaScript 注释
37 11
|
4月前
|
网络架构
若依修改 :id 不跳转注释的资料,路由配置:id不跳转修改,若依的store的permission.js对动态路由有控制
若依修改 :id 不跳转注释的资料,路由配置:id不跳转修改,若依的store的permission.js对动态路由有控制
若依修改 :id 不跳转注释的资料,路由配置:id不跳转修改,若依的store的permission.js对动态路由有控制
|
4月前
|
JavaScript 前端开发
node.js 导入导出模块(CommonJS模块化规范,ES6模块化规范)
node.js 导入导出模块(CommonJS模块化规范,ES6模块化规范)
54 1
|
5月前
|
JavaScript 前端开发
JavaScript的规范代码风格
JavaScript的规范代码风格
24 1
|
5月前
|
算法 JavaScript 前端开发
【经典算法】LCR187:破冰游戏(约瑟夫问题,Java/C/Python3/JavaScript实现含注释说明,Easy)
【经典算法】LCR187:破冰游戏(约瑟夫问题,Java/C/Python3/JavaScript实现含注释说明,Easy)
82 1
|
5月前
|
存储 JavaScript 前端开发
【经典算法】LeetCode350:两个数组的交集 II(Java/C/Python3/JavaScript实现含注释说明,Easy)
【经典算法】LeetCode350:两个数组的交集 II(Java/C/Python3/JavaScript实现含注释说明,Easy)
30 1