前端编码规范-一般规范

1. my-script.js
2. my-camel-case-name.css
3. i-love-underscores.html
4. thousand-and-one-scripts.js
5. my-file.min.css

协议

不要指定引入资源所带的具体协议。

当引入图片或其他媒体文件，还有样式和脚本时，URLs 所指向的具体路径，不要指定协议部分（http:, https:），除非这两者协议都不可用。

不指定协议使得 URL 从绝对的获取路径转变为相对的，在请求资源协议无法确定时非常好用，而且还能为文件大小节省几个字节。

不推荐

1. <script src="http://cdn.com/foundation.min.js"></script>

推荐

1. <script src="//cdn.com/foundation.min.js"></script>

不推荐

1. .example {
2. background: url(http://static.example.com/images/bg.jpg);
3. }

推荐

1. .example {
2. background: url(//static.example.com/images/bg.jpg);
3. }

文本缩进

一次缩进两个空格。

1. <ul>
2. <li>Fantastic</li>
3. <li>Great</li>
4. <li>
5. <a href="#">Test</a>
6. </li>
7. </ul>

1. @media screen and (min-width: 1100px) {
2. body {
3. font-size: 100%;
4. }
5. }

1. (function(){
2. var x = 10;
3.  
4. function y(a, b) {
5. return {
6. result: (a + b) * x
7. }
8.  
9. }
10. }());

注释

注释是你自己与你的小伙伴们了解代码写法和目的的唯一途径。特别是在写一些看似琐碎的无关紧要的代码时，由于记忆点不深刻，注释就变得尤为重要了。

编写自解释代码只是一个传说，没有任何代码是可以完全自解释的。而代码注释，则是永远也不嫌多。

当你写注释时一定要注意：不要写你的代码都干了些什么，而要写你的代码为什么要这么写，背后的考量是什么。当然也可以加入所思考问题或是解决方案的链接地址。

不推荐

1. var offset = 0;
2.  
3. if(includeLabels) {
4. // Add offset of 20
5. offset = 20;
6. }

推荐

1. var offset = 0;
2.  
3. if(includeLabels) {
4. // If the labels are included we need to have a minimum offset of 20 pixels
5. // We need to set it explicitly because of the following bug: http://somebrowservendor.com/issue-tracker/ISSUE-1
6. offset = 20;
7. }

一些注释工具可以帮助你写出更好的注释。JSDoc 或 YUIDoc 就是用来写 JavaScript 注释用的。你甚至可以使用工具来为这些注释生成文档，这也是激励开发者们写注释的一个好方法，因为一旦有了这样方便的生成文档的工具，他们通常会开始花更多时间在注释细节上。
 

代码检查

对于比较宽松自由的编程语言来说，严格遵循编码规范和格式化风格指南就显得极为重要。遵循规范固然很好，但是有自动化流程来确保其执行情况，岂不更佳。Trust is good, control is better.

对于 JavaScript，建议使用 JSLint 或 JSHint。

[1]: Compass 是一个基于 Sass 开源的 CSS 框架，而 Sass 是一个非常流行的 CSS 预编译器。