?

这是一套适用于javascript程序的编码规范。 它基于Sun的Java程序编码规范。 但进行了大幅度的修改, 因为javascript不是Java。

软件的长期价值直接源于其编码质量。 在它的整个生命周期里,一个程序可能会被许多人阅读或修改。 如果一个程序可以清晰的展现出它的结构和特征,那就能减少在以后对其进行修改时出错的可能性。

编程规范可以帮助程序员们增加程序的健壮性。

所有的javascript代码都是暴露给公众的。 所以我们更应该保证其质量。 保持整洁很重要。

javascript文件

javascript程序应独立保存在后缀名为.js的文件中。

javascript代码不应该被包含在HTML文件中,除非这是段特定只属于此部分的代码。 在HTML中的javascript代码会明显增加文件大小,而且也不能对其进行缓存和压缩。

filename.js应尽量放到body的后面。 这样可以减少因为载入script而造成其他页面内容载入也被延迟的问题。 也没有必要使用 language或者type属性。 MIME类型是由服务器而非scripttag来决定的。

缩进

缩进的单位为四个空格。 避免使用Tab键来缩进(即使现在已经是21世纪了),也始终没有个统一的Tab长短标准。 虽然使用空格会增加文件的大小,但在局域网中几乎可以忽略,且在 最小化过程中也可被消除掉。

每行长度

避免每行超过80个字符。

当一条语句一行写不下时,请考虑折行。 在运算符号,最好是逗号后换行。在运算符后换行可以减少因为复制粘贴产生的错误被分号掩盖的几率。 下一行应该缩进8个空格。

注释

不要吝啬注释。

给以后需要理解你的代码的人们(或许就是你自己)留下信息是非常有用的。 注释应该和它们所注释的代码一样是书写良好且清晰明了。 偶尔的小幽默就更不错了。 记得要避免冗长或者情绪化。

及时地更新注释也很重要。 错误的注释会让程序更加难以阅读和理解。

让注释有意义。重点在解释那些不容易立即明白的逻辑上。

不要把读者的时间浪费在阅读类似于:

    i = 0; // 让i等于0

使用单行注释。 块注释用于注释正式文档和无用代码。

变量声明

所有的变量必须在使用前进行声明。

javascript并不强制必须这么做,但是这么做可以让程序易于阅读, 且也容易发现那些没声明的变量(它们会被编译成全局变量)。

将var语句放在函数的首部。

最好把每个变量的声明语句单独放到一行,并加上注释说明。 所有变量按照字母排序。

var currentEntry; // 当前选择项    
var level;        // 缩进程度    
var size;         // 表格大小

javascript没有块范围,所以在块里面定义变量很容易引起C/C++/Java程序员们的误解。 在函数的首部定义所有的变量。