PDF《1. 关于》

6 前端一般性规范 源名称的好选择. 请确保文件命名总是以字母开头而不是数字.而以特殊字符开头命名的文件,一般都有特殊的含义与用处 (比如 compass1 中的下划线就是用来标记跳过直接编译的文件用的). 资源的字母名称必须全为小写,这是因为在某些对大小写字母敏感的操作系统中,当文件通过工具压缩混 淆后,或者人为修改过后,大小写不同而导致引用文件不同的错误,很难被发现. 还有一些情况下,需要对文件增加前后缀或特定的扩展名(比如 .min.js , .min.css ),抑或一串前缀 (比如 3fa89b.main.min.css ).这种情况下,建议使用点分隔符来区分这些在文件名中带有清晰意义的 元数据. 不推荐 MyScript.js myCamelCaseName.css i_love_underscores.html 1001-scripts.js my-file-min.css 推荐 my-script.js my-camel-case-name.css i-love-underscores.html thousand-and-one-scripts.js my-file.min.css 建议在指向图片、样式表、JavaScript脚本或者其它媒体文件的URL地址中省略 http: 与 https: 协议 部分,除非已知相应文件不能同时兼容这两个协议,比如: 我们不推荐下面这种方式: .example { background: #fff url(http://www.doraemoney.com/assets/img/example-background.png) no-repeat cente } 你应该像下面这样写: 协议头 代码编写规范

7 前端一般性规范 .example { background: #fff url(//www.doraemoney.com/assets/img/example-background.png) no-repeat center } 另外的示例,比如通过 标签引入图片,我们同样不推荐这样写: 而应该这样写: 不允许在任何 HTML 、 CSS 以及 JavaScript 代码中使用 Tab 进行缩进,且所有的缩进只允许使用两 个空格 __ ,如下面这样是正确的: @media screen and (min-width: 1100px) { body { font-size: 100%;

} } (function(){ var x = 10;

function y(a, b) { return { result: (a + b) * x } } }());

而下面这样均为错误的: 代码缩进 代码编写规范

8 前端一般性规范 所有的代码都应该是小写的,包括元素名称、属性、属性值(除非 text 或者 CDATA 的内容)、选择 器、CSS属性以及属性值,如下面这样均是错误的: 叮当钱包 正确的写法应该是: 叮当钱包 对于资源文件的命名,我们同样要求全部使用纯小写字母,同时,多个单词间使用中横线分割( - ),同时,不允许在命名中出现空格,英文字母必须放在第一个位置, - 不允许出现在名称格式后缀小数点 . 的前面,如下面这样就是正确的命名方法: logo.png example-background.png assets/css/base.css 而下面这些均是错误的: logo-.png -logo.png 0logo.png example background.png Example-Background.png ExampleBackground.png Assets/Css/Base.css 尾随空格是绝对不允许的,容易让 diff 更加复杂,比如下面这样是不允许的: 什么是叮当钱包? 叮当钱包的命名灵感来源于哆啦A梦的四次元口袋,叮当希望自己也可以像这个神奇口袋一样,在小伙伴需要帮助时,伸出温暖援(圆) 下面这样才是正确的: 什么是叮当钱包? 叮当钱包的命名灵感来源于哆啦A梦的四次元口袋,叮当希望自己也可以像这个神奇口袋一样,在小伙伴需要帮助时,伸出温暖援(圆) 注意仔细观察,在 h2 标签中 ? 号后面有无空格. 大小写 尾随空格 代码编写规范

9 前端一般性规范 所有的文件,包括 .html 、 .css 、 .js 、 scss 、 less 等,必须全部使用 utf-8 编码格式,如下面 这样的是正确的: 注释是你自己与你的小伙伴们了解代码写法和目的的唯一途径.特别是在写一些看似琐碎的无关紧要的代 码时,由于记忆点不深刻,注释就变得尤为重要了. 编写自解释代码只是一个传说,没有任何代码是可以完全自解释的.而代码注释,则是永远也不嫌多. 当你写注释时一定要注意:不要写你的代码都干了些什么,而要写你的代码为什么要这么写,背后的考量 是什么.当然也可以加入所思考问题或是解决方案的链接地址. 任何编写代码的人都必须根据需要撰写代码注释,对于团队开发来说,这是非常重要的,比如下方是HTML 的注释规范: 不推荐 var offset = 0;