JavaScript编码规范(1)
我们来看一下一段糟糕的编码形象：
//打个招呼
function func(){
var age=18,sex='man';
var greeting='hello';
if(age<=18&&sex=='man'){
console.log(greeting+'little boy')
}
...
}
func()
上方代码整体缩在了一起，缺乏规范意识，阅读体验很差，不忍直视。
再来看一段良好的代码形象：
// 打个招呼
function greetFn() {
var age = 18,
sex = 'man',
greeting = 'hello';
if (age <= 18 && sex === 'man') {
console.log(greeting + 'little boy');
}
...
};
greetFn();
上方的代码是不是感觉舒服多了？
由此可见养成一个良好的编码形象是至关重要的，而本文主要讲解的是基于JavaScript的编码形象，即基于JavaScript的编码风格和编码规范。
那么什么是编码风格，什么是编码规范，两者的区别又是什么？
编码风格
首先编码风格既然是风格，就没有对错之分。就好比每个人的穿着打扮不同，有的人穿的比较得体，有的人穿的比较随意而已。
而在JavaScript编码风格中，也有一套比较得体的风格，尤其在团队开发中，我们不能随意的书写属于自己的风格。
下面就列举几种随意的编码风格，并将其与良好的编码风格进行对比。
1.合理注释
// 不推荐的写法
var name = '劳卜';//代码和注释之间没有间隔
if (name) {
/*
*注释之前无空行
*星号后面无空格
*/
}
// 推荐的写法
var name = '劳卜'; // 代码和注释之间有间隔
if (name) {
/*
* 注释之前有空行
* 星号后面有空格
*/
}
2.合理间隔
// 不推荐的写法
var name='劳卜'; // 等号和两侧之间没有间隔
// if块级语句间没有间隔
if(name){
console.log('hello');
}
// 推荐的写法
var name = '劳卜'; // 等号和两侧之间有间隔
// if块级语句间有间隔
if (name) {
console.log('hello');
}
3.合理缩进
// 不推荐的写法：没有合理缩进
function getName() {
console.log('劳卜');
}
// 推荐的写法：合理缩进
function getName() {
console.log('劳卜');
}
4.合理空行
// 不推荐的写法: 代码功能块之间没有空行
function getName() {
var name = '劳卜';
if (name) {
console.log('hello');
}
}
// 推荐的写法：代码功能块之间有空行
function getName() {
var name = '劳卜';
if (name) {
console.log('hello');
}
}
5.合理命名
// 不推荐的写法
var getName = '劳卜'; // 变量命名前缀为动词
// 函数命名前缀为名词
function name() {
console.log('hello');
}
// 推荐的写法
var name = '劳卜'; // 变量命名前缀为名词
// 函数命名前缀为动词
function getName() {
console.log('hello');
}
6.合理声明
// 不推荐的写法：函数在声明之前使用
getName();
function getName() {
console.log('hello');
}
// 推荐的写法：函数在声明之后使用
function getName() {
console.log('hello');
}
getName();
7.合理结尾
// 不推荐的写法：没有使用分号结尾
var name = '劳卜'
var getName = function() {
console.log('hello')
}
// 推荐的写法：使用分号结尾
var name = '劳卜';
var getName = function() {
console.log('hello');
};
以上主要列举了7个比较常见的编码风格的例子进行了比较，在推荐的写法和不推荐的写法中两者并没有对错之分，只是推荐的写法相比较而言更容易阅读和维护，更适用于团队开发，也是良好编码形象的体现。
本文参与 腾讯云自媒体分享计划，分享自作者个人站点/博客。
原始发表：2017/03/15 ，如有侵权请联系 cloudcommunity@tencent.com 删除
评论
登录后参与评论
推荐阅读