通用代码规范.md
1.37 KB
通用代码规范
文件/资源命名
文件,资源,目录等全部小写命名,有多个单词组成时以中划线-
分隔;有复数结构时,采用复数命名。
对于压缩文件等有需要特殊前缀的文件使用点.
进行划分,比如a.min.js。
//GOOD
my-script.js
my-camel-case-name.css
i-love-underscores.html
thousand-and-one-scripts.js
my-file.min.css
//BAD
MyScript.js
myCamelCaseName.css
i_love_underscores.html
1001-scripts.js
my-file-min.css
文本缩进
一次缩进4个空格
注释
原则:适量,并且切中要害 必要的注释使用场景
- 代码晦涩难懂
- 可能被别人误认为是错误的代码
- 必要但是并不明显的针对特定浏览器的代码
- 恰当的文档注释
NOTE:大段的代码注释尽量予以避免,N久后,那段代码的存在会成为你和大家的绊脚石
代码检查
对于比较宽松自由的编程语言来说,严格遵循编码规范和格式化风格指南就显得极为重要。遵循规范固然很好,但是有自动化流程来确保其执行情况,岂不更佳。Trust is good, control is better.
对于 JavaScript的代码检查,建议使用JSHint。(sublime Text中可以安装jshint插件)