Web技术应用规范（草案）

第一章 总则

第一条 目的

前端开发是一系列工具和流程的集合，本规范旨在提升前端代码的质量，对前端开发进行全方位指导，统一编码规范、提高可读性、降低维护成本，以实现高效、可持续的工作流。

第二条 范围

本标准适用于所有的Web应用及App开发。

第二章 开发规范

第三条 一般规范

应用在HTML、CSS、JavaScript等的通用规则。

3.1 通用规范

3.1.1 技术选型

前端是一门发展中的技术，标准、框架等更新速度快、调整幅度大，技术选型时应考虑到开源技术中适用于当前项目的多种可能，多角度考察比较，并从中选取框架运行稳定的版本，在技术储备充足时，应兼顾考虑相对前沿技术。

3.1.2 目录结构

规范的文件目录结构有助于提高项目的逻辑结构合理性，对应用扩展和合作，及团队开发均有益处。
应用的核心框架、静态资源、脚本模块、上传文件等应分置不同文件，严格遵循模块化开发的要求，尽量做到规范化。不需要直接暴露给用户的文件，应该放在web服务器访问不到的目录，避免泄露设置信息。

3.1.3 文件资源命名

1).项目命名全部采用小写，以下划线分隔；
2).使用驼峰方式命名文件名与文件所在的文件夹，便于统一配置；
3).确保文件命名总以字母开头而不是数字；

3.1.4 编码格式

通过声明一个明确的字符编码，让浏览器快速确定适合的渲染方式，通常指定为’UTF-8’。

3.1.5 文本缩进

采用四个空格或者Tab缩进，不要混用。

3.1.6 代码注释

注释是对无法自我说明的代码进行解释，注释可提高代码的可维护性、可读性，开发人员应在必要时添加符合规范的注释。注释应至少包含方法、函数的作者/维护人，描述，出入参，示例及维护日期等信息。如下场景必须添加注释：

1). 核心代码及较晦涩部分。
2). 易存在错误的代码段。
3). 浏览器特殊的HACK代码。
4). 业务逻辑强相关的代码。

3.1.7 代码检查

对于JavaScript这种弱类型的编程语言，严格遵循编码规范和格式化风格非常重要。前端开发人员需严格遵循开发规范，并使用自动代码检查工具(如ES