project.mdc 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. ---
  2. description:
  3. globs:
  4. alwaysApply: true
  5. ---
  6. # Cursor项目规则
  7. ## 项目技术栈
  8. 本项目基于以下技术栈搭建:
  9. - Vue 3
  10. - Pinia
  11. - typescript
  12. - rspack
  13. ## 公共组件规范
  14. 尽量实现公共的组件和方法 组件应当在components文件夹下面
  15. ## 代码风格规范
  16. ### 编码原则
  17. - **可读性优先**:代码应当易于理解,结构清晰,避免过度复杂的实现
  18. - **高效简洁**:追求高效的代码执行和简洁的代码表达,避免冗余
  19. - **实用性为主**:优先采用常用、成熟的编程模式,避免使用晦涩难懂的"高大上"技巧
  20. ### 注释规范
  21. - 所有代码必须包含中文注释
  22. - 业务逻辑必须有相应的注释说明
  23. - 复杂的逻辑处理必须有详细的步骤注释
  24. - 函数和组件应当有清晰的功能说明注释
  25. ## 开发流程
  26. - 在开始新功能开发前,请先熟悉本项目的公共组件和代码规范
  27. - 代码提交前进行自检,确保符合上述规范要求
  28. - 有疑问时请参考已有代码实现或向团队成员咨询