注释规范及代码风格整理

注释规范

• 在html中单行注释为 <！-- 这里是单行注释 -- >；
• 在html中多行注释为 <!-- 多行注释相同 -->；
• 在javascript中单行注释为 //这里是单行注释；
• 在javascript中多行注释为/* 这是多行注释 */；
• 在css中的注释/*这是单行注释*/；
• 在css中的注释/*多行注释相同*/；

代码风格

• 代码风格分为两种，一种是社区型，一种是工作团队型，社区的代码风格多是建议类型，不进行硬性规定，而在实际工作中，往往会通过某种途径来强制团队中的成员使用相同的代码风格；
• 代码风格规范举例：Javascript Standard Style 、Airbnb Javascript Style；
• Javascript Standard Style使用细则：
  1、使用两个空格进行缩进；
  2、字符串使用单引号；
  3、去除了冗余变量的影响；
  4、无分号；
  5、收行不以（，【，or开头 ；
  6、关键字后加空格，例 if (condition) {…} ；
  7、函数名后加空格function name (arg) {…} ；
  8、坚持使用全等 === ；
  9、一定要处理Node.js中错误回调传递进来的err参数 ；
  10、使用浏览器全局变量时加上window前缀 - document and navigator 除外 ；
• Airbnb的目录举例（体现约束范围更广泛）
  1、类型 ；
  2、对象 ；
  3、数组 ；
  4、字符串 ；
  5、函数 ；
  6、属性 ；
  7、变量 ；
  8、提升 ；
  9、比较运算符&等号 ；
  10、 块，注释，空白，逗号，分号，类型转换，命名规则，存储器，构造函数，事件，模块等等 ；
• 对代码如何写不清楚的人群，可以使用格式化工具将代码进行整理；