CodingStandard

这一生的挚爱 提交于 2019-11-26 17:18:45

规范

文件命名规范

一律小写,必须是英文单词或产品名称的拼音,多个单词用下划线()连接。只能出现英文字母、数字、下划线和连字符(-)。 连字符(-)的使用场景为:英文单词中的组合词,比如thunder-like_delivery_48x48.png. 除此之外,都使用下划线连接。 文件名中的版本号,需要用字母v做为前缀,小版本用英文字母a-z表示,比如address_and_postage_v2a.js. 该命名规范适用于html, css, js, swf, php, xml, png, gif, jpg, ico等前端维护的所有文件类型。 tbsp和tbra目录下的文件名沿用YUI的命名规则,特殊处理,不要仿效。

id和class命名规范

- id和class的命名总规则为:内容优先,表现为辅。首先根据内容来命名,比如main-nav. 如果根据内容找不到合适的命名,可以再结合表现来定,比如skin-blue, present-tab, col-main.

id和class名称一律小写,多个单词用连字符连接,比如recommend-presents. id和class名称中只能出现小写的26个英文字母、数字和连字符(-),任何其它字符都严禁出现。 id和class尽量用英文单词命名。确实找不到合适的单词时,可以考虑使用产品的中文拼音,比如wangwang, dating. 对于中国以及淘宝特色词汇,也可以使用拼音,比如xiaobao, daigou. 除了产品名称和特色词汇,其它任何情况下都严禁使用拼音。 在不影响语义的情况下,id和class名称中可以适当采用英文单词缩写,比如col, nav, hd, bd, ft等,但切忌自造缩写。 id和class名称中的第一个词必须是单词全拼或语义非常清晰的单词缩写,比如present, col. 仅在JavaScript中当作hook用的id和class, 命名规则为J_UpperCamelCase, 其中字母J代表JavaScript, 也是钩子(hook)的象形。注意:如果在JavaScript和CSS中都需要用到,则不用遵守本约定。

缩进和行长

缩进的单位为四个空格。如果使用Tab键来缩进,请在编辑器中设定Tab的长度为四个空格。 避免每行超过120个字符。当一条语句一行写不下时,请折行。

注释

不要吝啬注释。给以后需要理解你的代码的人们(或许就是你自己)留下信息是非常有用的。注释应该和它们所注释的代码一样是书写良好且清晰明了。偶尔的小幽默就更不错了。记得要避免冗长或者情绪化。 及时地更新注释也很重要。错误的注释会让程序更加难以阅读和理解。 要让注释有意义。重点在解释那些不容易立即明白的逻辑上。不要把读者的时间浪费在显而易见的代码上

下面是一些零散建议,虽然不同于上面的硬性规范,但依旧希望大家在工作中能尽量去做到。保持良好的编程习惯很重要。

尽量遵守内容(Content)、表现(Presentation)和行为(Behavior)的分离原则。 书写HTML文档时,尽量符合语义,要让正确的元素表达正确的事。比如:严禁用table进行布局,但是,在展现数据时,该用table的时候就大胆的用。 推荐用双引号引用HTML文档中的属性值。推荐用单引号引用css和js语句中的字符串。 尽量做到性能优化,遵守Best Practices for Speeding Up Your Web Site.

来源:开源项目JET

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!