代码规范
本文档旨在提供一个清晰、统一的编码标准和最佳实践指南,以帮助团队成员高效协作,编写出高质量、可维护且易于理解的代码。
遵循这些规范将有助于:
- 提高代码质量:通过统一的标准减少常见错误和潜在陷阱。
- 增强可读性与可维护性:使代码风格一致,方便团队成员快速理解和修改。
- 提升开发效率:减少因代码风格不一致而产生的沟通成本,让开发者更专注于业务逻辑。
- 保障应用性能与安全:集成性能优化和安全编码的最佳实践。
请根据您的开发任务,查阅以下详细规范文档。
HTML 规范
本规范定义了编写语义化、可访问且结构清晰的 HTML 文档的标准,涵盖了从文档结构、代码格式到元素使用的各个方面。
CSS 规范
本规范统一了团队的 CSS/SCSS 代码风格,重点介绍了如何有效使用 Tailwind CSS,并为原生 CSS/SCSS 提供了详细的格式化、命名和结构化指南。
JavaScript/TypeScript 规范
本规范基于 Airbnb 风格指南,为 JS/TS 项目提供了一套全面的编码标准,内容涵盖变量、数据类型、函数、模块化以及异步编程等最佳实践。
React 规范
本规范专为 React 项目设计,详细说明了组件定义、JSX 语法、Hooks 使用、性能优化以及安全性等方面的编码标准和最佳实践。
Vue 规范
本规范为 Vue.js 项目提供了一套完整的代码风格和开发约定,结合了 Vue 官方风格指南,涵盖了从组件命名到状态管理的各项规则。
测试代码规范
本规范旨在为前端团队提供一套统一的测试代码编写标准,覆盖了 Jest(单元/集成测试)、React Testing Library(组件测试)和 Playwright(E2E 测试),以提高测试质量和可维护性。