说一说你平时写代码遵守的编码规范
- 文件/资源命名
文件名应遵循同一命名约定。以可读性而言,减号(-)是用来分隔文件名的不二之选,同时它也是常见的 URL 分隔符,所以减号也是用来分隔资源名称的较佳选择。我们应确保文件命名总是以字母开头而不是数字,以特殊字符开头命名的文件,一般都有特殊的含义与用处,不能轻易使用。资源的字母名称必须全为小写,因某些对大小写字母敏感的操作系统中,当文件通过工具压缩混淆或者人为修改后,大小写不同而导致引用文件不同的错误很难被发现。 - 注释是你与小伙伴们了解代码写法和目的的唯一途径。特别是在写一些看似琐碎的无关紧要的代码后,由于记忆点不深刻,注释就变得尤为重要了。
编写自解释代码只是一个传说,没有任何代码是可以完全自解释的。而代码注释永远也不嫌多。注意:不要写你的代码都干了些什么,而要写你的代码为什么要这么写,背后的考量是什么。当然也可以加入所思考问题或是解决方案的链接地址。 - 遵循语义化标准但注重实用性,避免多余的父节点,以较小复杂度和较少的标签解决问题。
- 在页面开头用doctype来启用标准模式,使其在每个浏览器中尽可能一致的展现,照惯例DOCTYPE大写。
- 在html标签上加上lang属性。这会告诉语音工具和翻译工具应怎么去发音和翻译。
- 指定
<meta charset="UTF-8">
,让浏览器轻松渲染并减少乱码的可能。 - 嵌套的节点需缩进以保持结构工整。
- 属性名全小写。
- 属性值使用双引号。
- 除自闭合标签外所有标签都应成对出现。
- 选择器内的属性值对要使用缩进。
- 不使用内联样式。
- 使用有意义的单词作为选择器名称,让读代码的人一看就知道你写的是哪部分的样式。
- 每个属性声明属性名后加空格,属性值末尾要加分号。
- 注释统一用/* */,缩进与下一行代码保持一致。
- 最外层统一使用双引号,url的内容要用引号,属性值要用引号。
- 类名使用小写字母以中划线分隔,id采用驼峰式命名。
- 十六进制颜色名用小写字母且能简写一定简写。
- 属性值0后不要加单位。