博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
js中我的注释规范
阅读量:6804 次
发布时间:2019-06-26

本文共 814 字,大约阅读时间需要 2 分钟。

模块功能描述说明:

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

模块内的小函数方法归类:

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

单个函数方法:

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

单行注释:

//这是一条单行注释

单个函数方法中变量注释:

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

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

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

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

 

 

 

 

 

 

 

 

 

 

 

 

 

转载地址:http://conwl.baihongyu.com/

你可能感兴趣的文章
Android应用安全开发之浅谈网页打开APP
查看>>
后退时保存表单状态
查看>>
Python简介
查看>>
泛函编程(13)-无穷数据流-Infinite Stream
查看>>
XML与HTML
查看>>
find grep wc awk sed sort uniq split指令详解
查看>>
绩效管理功能扩展包
查看>>
#pragma的用法
查看>>
[jvm]体系结构 内存模型
查看>>
网站优化必须了解的三个基础知识
查看>>
Java 和Php 接口
查看>>
Samba文件共享服务
查看>>
Web开发模式【实例篇】MVC--迈向标准开发
查看>>
查看binlog文件的2种方式
查看>>
新人程序员如何脱颖而出
查看>>
网络工程师真的也需要好好学习linux系统
查看>>
Entangle 2.0 “Sodium”正式发布
查看>>
Redis之父表示ARM服务器没戏!
查看>>
java调用cmd命令并捕获执行结果字符串的代码
查看>>
Eclipse中android sdk升级ADT版本过低解决办法
查看>>