JavaScirpt 编码规范
文章目录
JavaScirpt 编码规范
简介
这套规范的主体是基于 JavaScript Stardard Style 的内容基于自身的业务需要和情况来进行自我定制和更新。
重点
1.缩进
-
使用两个空格进行缩进。
function hello(name) { console.log('hi', name) }
2.命名
-
对于变量和函数名统一使用驼峰命名法。
function my_function() {} // ✗ avoid function myFunction() {} // ✓ ok var my_var = 'hello' // ✗ avoid var myVar = 'hello' // ✓ ok -
私有属性、变量和方法以下划线 _ 开头。
var _privateMethod = {};` -
类使用 Pascal 命名法。
function TextNode(value, engine) { this.value = value this.engine = engine } -
类的方法 / 属性, 使用 Camel 命名法。
TextNode.prototype.clone = function() { return this } -
常量: 必须全部大写,且单词以
_分割。TextNode.prototype.clone = function() { return this } -
boolean 类型的变量使用 is 或 has 开头。
var HOTEL_GET_URL = 'http://map.baidu.com/detail'
3.注释。
// 单行注释
/*
*hello
*world
*/
说明: 若开始`/*`和结束`*/`都在一行,推荐采用单行注释。若至少三行注释时,第一行为`/*`,最后行为`*/`,其他行以*开始,并且注释文字与`*`保留一个空格。
4.不要使用 eval()。
eval('var result = user.' + propName) // ✗ avoid
var result = user[propName] // ✓ ok
细则
使用
使用 Eslint,配置为 Standrd.
extends: 'standard',
后续?
- 函数命名语义规范
- 变量语义规范
- 编码原则
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论