web前端编码规范.docVIP

前端编码规范——一般规范 这是一份旨在增强团队的开发协作，提高代码质量和打造开发基石的编码风格规范，其中包含了 HTML, JavaScript 和 CSS/SCSS 这几个部分。我们知道，当一个团队开始指定并实行编码规范的话，错误就会变得更加显而易见。如果一段特定的代码不符合规范的话，它有可能只是代码风格错误，而也有可能会是 bug。早期指定规范就使得代码审核得以更好的开展，并且可以更精确的地定位到错误。只要开发者们能够保证源代码源文件都严格遵循规范，那接下去所使用的混淆、压缩和编译工具则可投其所好不尽相同。一般规范 以下章节列举了一些可应用在 HTML, JavaScript 和 CSS/SCSS 上的通用规则。文件/资源命名 在 web 项目中，所有的文件名应该都遵循同一命名约定。以可读性而言，减号（-）是用来分隔文件名的不二之选。同时它也是常见的 URL 分隔符（i.e.?///blog/my-blog-entry?or?///images/big-black-background.jpg），所以理所当然的，减号应该也是用来分隔资源名称的好选择。 请确保文件命名总是以字母开头而不是数字。而以特殊字符开头命名的文件，一般都有特殊的含义与用处（比如 compass[1]?中的下划线就是用来标记跳过直接编译的文件用的）。 资源的字母名称必须全为小写，这是因为在某些对大小写字母敏感