SMG研发中心Web前端开发规范

"Web前端项目开发规范" 本文档主要针对Web前端项目开发制定了一系列规范，旨在提升团队协作效率，确保后台人员能方便地添加功能，并且方便前端的后续优化和维护。规范内容包括通用规范、命名规范以及文件引用等方面，旨在产出高质量的文档，促进项目的有序进行。 1. **通用规范** - **文本缩进**：所有代码应使用两个空格进行缩进，避免使用Tab或混合使用Tab和空格，以保持代码的一致性。 - **前端预处理框架**：推荐使用SASS作为CSS预处理框架，构建统一的前端样式系统。对于H5等前后端不分离的项目，可根据实际情况考虑是否采用。 - **项目结构**：文档提供了标准的项目目录结构，包括入口页(index.html)、JS目录、控制器目录、库目录、插件目录、视图目录、CSS目录、图片目录和HTML模板目录。这样的结构有助于代码组织和管理。 2. **命名规范** - **驼峰式命名法**：分为大驼峰(PascalCase)和小驼峰(CamelCase)，用于标识符命名，如变量、函数和对象。 - **文件资源命名**：文件名不应包含空格，推荐全小写字母，单词间用连字符(-)分隔。特殊情况如README、LICENSE等可使用大写字母。 - **引入资源**：推荐使用相对路径，不指定具体协议，如使用`//cdn.com/foundation.min.js`而非`http://cdn.com/foundation.min.js`，以适应不同协议环境。 3. **变量命名** - 推崇使用小驼峰式命名法，并建议以类型+对象描述的方式来命名变量，若无明确类型，可直接使用名词作为前缀。例如，推荐使用`var tableTitle = "LoginTable"`而非`var va`。 4. **其他** - 本文档要求前端开发人员严格遵循这些规范，以确保代码质量。同时，文档是动态的，如有不合理之处，团队成员应及时提出，经讨论后进行修改。 这份Web前端项目开发规范为前端开发者提供了一套完整的指导原则，涵盖了代码风格、文件组织和命名约定等多个方面，有助于创建整洁、易于维护的代码库，从而提升团队的整体开发效率和项目质量。