开发规范

1. 代码风格

1.1 代码格式化

• 使用 Prettier 进行代码格式化，确保所有代码风格一致。
• 配置文件：.prettierrc.json

1.2 代码缩进

• 配置文件：.editorconfig

1.3 命名规范

• 变量和函数名使用 camelCase。
• 组件名使用 PascalCase。
• 常量使用 UPPER_SNAKE_CASE。

1.4 注释

• 使用 JSDoc 风格的注释来描述函数和类。
• 注释应清晰、简洁，解释代码的目的和逻辑。

1.5 Vue 组件

• 组件文件名使用 PascalCase，例如 UserProfile.vue。
• 组件的 props 应使用 camelCase，并在 props 中进行类型和默认值的定义。
• 组件的 computed 属性应使用 camelCase。
• 组件的 watch 属性应使用 camelCase。

1.6 文件命名

• 组件文件名使用 PascalCase，例如 UserProfile.vue。
• 其他文件名使用 camelCase，例如 userService.ts。

2. 文档

2.1 代码注释

• 在关键逻辑和复杂函数中添加注释，解释代码的目的和逻辑。
• 使用 JSDoc 风格的注释来描述函数和类。

2.2 项目文档

• 使用 README.md 文件来描述项目的基本信息、安装步骤、使用方法等。
• 使用 docs 目录来存放详细的文档，例如 API 文档、架构设计文档等。

通过遵循上述开发规范，可以确保团队成员在开发过程中保持一致的代码风格和最佳实践，提高代码的可读性和可维护性。