Hx前端技术规范文档

Appearance

代码规范 ​

欢迎来到代码规范文档中心。这里提供了前端开发中需要遵循的各种规范和最佳实践。

基础规范 ​

前端三剑客 ​

项目管理 ​

框架开发 ​

  • Vue2 开发规范 - Vue.js 2.x 项目的开发规范，包含组件、状态管理、路由等
  • Vue3 开发规范 - Vue.js 3.x 项目的开发规范，包含组合式 API、Pinia、TypeScript 等

进阶规范 ​

为什么需要代码规范？ ​

  1. 提高代码质量 - 统一的规范让代码更易读、易维护
  2. 提升团队协作 - 减少代码风格差异，提高协作效率
  3. 降低维护成本 - 规范的代码更容易理解和修改
  4. 减少错误 - 遵循最佳实践可以避免常见错误
  5. 保证安全 - 安全规范可以有效防止常见的安全漏洞

规范文档结构 ​

docs/standard/
├── index.md              # 代码规范概述（本文件）
├── html.md               # HTML 编写规范
├── css.md                # CSS 编写规范
├── javascript.md         # JavaScript 编写规范
├── project-structure.md  # 项目结构规范
├── performance.md        # 性能优化规范
├── security.md           # 安全规范
├── git-commits.md        # Git 提交规范
├── vue2.md               # Vue2 开发规范
└── vue3.md               # Vue3 开发规范

如何使用这些规范？ ​

  1. 新人入职 - 作为学习资料，快速了解团队开发标准
  2. 日常开发 - 作为参考手册，随时查阅最佳实践
  3. 代码审查 - 作为审查标准，确保代码质量
  4. 团队讨论 - 作为讨论基础，不断完善团队规范

规范更新 ​

这些规范会随着技术发展和团队实践不断更新。如果你有任何建议或发现问题，欢迎提出改进意见。

提示

规范不是限制，而是帮助我们写出更好代码的指南。在实际开发中，请根据具体情况灵活应用。

注意

安全规范是必须严格遵守的，其他规范可以根据项目实际情况适当调整。

相关资源 ​