文件申明
顶部添加文件申明信息，包括文件描述、原始作者，如果有更新，则需要添加更新内容、更新作者和更新时间
/**
* @description: 说明文字
* @author: 张三
*/
/**
* @description: 说明文字
* @author: 张三
* @update: 更新内容 by 李四 2013-04-13 18:32
*/
单行注释与多行注释
无论是单行注释还是多行注释，注释中的每一行长度都不能超过 40 个汉字，或者 80 个英文字符。
单行注释
/* this is a short comment */
多行注释
/*
* this is comment line 1.
* this is comment line 2.
*/
html代码块注释
<!-- top navbar-->
----code-here----
<!-- top navbar end-->
<!-- sidebar-->
----code-here----
<!-- sidebar end-->
函数或方法注释
/**
* 这是一个求和函数
* @param {Number} a 第一个数字
* @param {Number} b 第二个数字
* @return {Number} 返回两个数字之和
*/
var sum = function(a, b) {
return a + b;
}
模块注释
模块注释必须单独写在一行
/* 模块：xxxxxx by 张三 */
...
/* 模块：xxxxxx by 张三 */
样式区块注释
/* header */
...
/* footer */
...
/* banner */
...
结束语：
规范不是规则，规范的作用诣在提高我们书写代码的效率、质量、可读性以及我们团队的工作效率，减少团队合作中因代码不规范所造成问题。规范不是要约束某一个人或者某些人，每个人可能在你看到这份规范的时候，都有自己的书写习惯，因为每个人在接触编程的时候不一定是先接触的规范。所以养成习惯是一个漫长的过程，改变习惯也是一个漫长的过程。规范像一把尺子，衡量每个人所产出代码的质量、规范、可读性等等，慢慢的改变自己书写代码的习惯，提高自己书写的代码的质量。常常自嘲的一句话：感觉自己写的代码就值五毛钱，别人的代码怎么那么好，整齐、可读性高，这代码值50啊。当你慢慢改变自己的编码习惯，朝着更高的要求去努力，当有一天你不再需要规范，因为你所产出的代码就是规范，这时你已经走在成为大神的路上了。
