肉渣教程

JS 代码风格

上一节 下一节

JS 代码风格

JavaScript是一种写起来比较随意的代码,随意但不应该随便。

对变量和函数的命名

对变量和函数的命名,尽量提现逻辑含义。可以使用英语,也可以使用汉语拼音(虽然有点low,但是这依然是一种值得支持的风格)。

而具体的命名,推荐两种写法,以“踢墙”为例,如下两种写法都比较推荐: kickWallkick_wall


上述的两种命名方式都推荐,但是不管选择哪一种方式,请保持统一,别混着用。


别吝啬空格

养成良好的编程习惯:在运算符的前后多加1个空格,在逗号的后面加1个空格。这样看起来会清爽很多。

var x = 10 + 12;
var arr = ["反清复明", "砍死吴三桂", "民主科学"];
var i;
for (i = 0; i < 5; i++) {
  x += i;
}

对齐就是美观

遥记当年学习建筑学基础时,最一开始会做构成训练,其中就会训练“对齐”,确实,对齐就是设计美学的要素之一。代码美学亦是如此;尽量让把代码写得对齐点,这总会显得内功深厚一点。至少这是好的修养的表现。举例:

var gangs = {
    "tiandi": "天地会";
    "riyue": "日月神教";
    "honghua": "红花会";
    "taiping": "太平天国";
    "yihe": "义和团";
    "xuesheng": "学生会";
    "xingxiu": "星宿派";
    "xueyuan": "学院派"
}

对齐就是美
对齐就是美
对齐就是美
对齐就是美
对齐就是美
对齐就是美
对齐就是美
对齐就是美
对齐就是美
对齐就是美
对齐就是美
美吧~

每行字符数 < 80

每行别太长,太长了老夫看起来累。因此,尊重老人,从写代码做起,尽量保持每行别太长。小于80个字符只是经验,大致感觉着就好啦~

document.getElementById("demo").innerHTML =
"地振高冈,一派西山千古秀;" + 
"门朝大海,三合河水万年流。" +
"反清复明";

养成使用注释的好习惯

注释是一个好习惯。


总之,写代码,要考虑到代码的可读性。不仅仅是考虑到别人来读,更是考虑到自己来读;否则,自己写的代码几个月后就忘了。


JS 代码风格

上一节 下一节