代码风格

代码风格

电脑程序是人类制造出来的最复杂的玩意儿.程序通常由很多部分组成,表现为函数,语句和表达式,它们必须准确无误地按照顺序排列.运行时行为几乎和实现它的程序没有什么相似之处.在软件的产品生命周期中,通常它们都会被修改.把一个正确的程序转化为另一个同样正确但风格不同的程序,是一个极具挑战性的过程.

优秀的程序拥有一个前瞻性的结构,它会预见到未来所需要的可能修改,但不会让其成为过度的负担.优秀的程序也有一种清晰的表达方式.如果一个程序被表达得很好,那么我们就能更容易地去理解他,以便成功地修改或修复它.

这些观点适用于所有的编程语言,且对JavaScript来说尤为正确.JavaScript的弱类型和过度的容错并没有给程序质量带来什么编译时的保证,所以为了弥补,我们应该按照严格的规范来进行编码.

JavaScript包含大量脆弱的或有问题的特性,它们会妨碍我们写出优秀的程序.显然我们应该避免JavaScript中那些糟糕的特性.令人惊讶的是,或许我们也应该避免那些通常很有用但偶尔有害的特性.这样的特性让人既爱又恨,然而,通过避免它们,就能避免一大类潜在的错误.

对于一个组织机构来说,软件的长期价值是和代码库的质量成正比的.在程序的生命周期里,会经历很多人的检测,使用和修改.如果一个程序能很清楚地传达它的结构和特性,那么当它在并不遥远的将来被修改时,它被破坏的可能性就小很多.

JavaScript代码经常被直接发布.它应该自始至终具备发布质量.整洁是会带来价值的.通过在一个清晰且始终如一的风格下编写,你的程序会变得易于阅读.

程序员会无休止地讨论良好的风格是由什么构成的.大多数程序员坚定地植根于他们过去是怎么用的,诸如他们在学校或在他们第一份工作时学到的最普遍的风格.他们中的一些人拥有高薪的工作但完全没有代码风格的意识.这不就证明了风格不重要吗?即使风格不重要,是不是某个风格不如其他的风格呢?

事实证明代码风格在编程中是很重要的,就像文字风格对于写作是重要的一样.好的风格促使代码能被更好地阅读.

电脑程序有时被人为不是用来读的媒介,所以只要它工作,写成怎样是不重要的.但是结果证明,如果程序具有可读性,将显著增强它正常运行的可能性,以及是否准确按照我们的意图去工作的可能性,它也决定了软件在其生命周期中是否能进行扩展性修改.如果我们能阅读并且理解程序,那么就有希望去修改和提高它.

我始终采用一致的风格.我的目的是使代码实例尽可能的易于阅读.我始终使用空白来给你更多关于程序的含义的提示.

我对代码块内容和对象字面量缩进4个空格.我放了一个空格在if和(之间,以致if不会看起来像一个函数调用.只有真的是在调用时,我才使(和其前面的符号相毗连.我在除了 . 和[外的所有中置运算符的两边都放了空格,它们俩无需空格是因为它们有更高的优先级.我在每个逗号和冒号后面都使用一个空格.

我在每行最多放一个语句.在一行里放多条语句可能会被误读.如果一个语句一行放不下,我将在一个冒号或二元运算符后拆开它.这将更好地防止复制/粘贴的错误被自动插入分好的机制所掩盖.我给折断后的语句的其余部分多缩进4个空格,如果4个还是不明显,就缩进8个空格.

我的代码包含了一些注释.我喜欢在程序中放入注释来留下一些信息,以后,它将会被那些需要理解我当时思路的人们(也可能是我自己)阅读.有时候觉得注释就像一个时间机器,我用它发送重要的信息给未来的我.

我努力保持注释是最新的.错误的注释甚至可能会使程序更难以阅读和理解.我不能容忍犯那样的错误.

在JavaScript中,我更喜欢用行注释.我将块注释用于正式的文档记录和注释.