.cursorrules 715 B

123456789101112131415161718192021
  1. # Tolan 项目开发规则
  2. ## 代码生成原则
  3. ### 文档生成规则
  4. - 在生成代码期间,尽量少生成 Markdown 文档
  5. - 如果必须生成 MD 文档,保持简洁,确保 AI 能看懂即可
  6. - 优先生成可执行的代码,而非详细的说明文档
  7. - 文档应该精简、实用、技术性强,避免过多描述性内容
  8. ### 代码优先
  9. - 重点放在功能实现上
  10. - 注释应该简洁明了
  11. - 文档只在必要时生成(如 README、配置说明)
  12. ### 文档简洁性要求
  13. - README: 只包含核心信息(安装、启动、基本使用)
  14. - 配置文档: 列出参数和示例即可
  15. - API文档: 接口定义和示例,无需详细解释
  16. - 避免生成过长的教程性文档