AugmentCode 工作区行为指南

通用沟通与文档偏好

• 沟通语言：请始终使用中文进行所有沟通和回复。
• 文档输出：在完成主要功能开发后，请将实现细节总结并写入项目的 README.md 文件。

Java 代码与架构规范

• API 响应：在设计或修改控制器 API 响应时，请确保参数全面且详细，避免过于精简的响应。
• 常量定义：所有常量都应提取到专门的常量类中，并附带清晰的中文 Javadoc 注释。
• Java 文件审查：审查所有 Java 文件，包括核心业务模块、工具类、控制器、服务和数据访问层。
• 代码可读性与可维护性：确保代码的可读性、易懂性、可维护性，避免过于复杂的代码结构和函数。
• 命名与组织：遵循代码组织和命名约定，以确保代码的可维护性。
• Javadoc：为工具类、常量定义和公共方法添加中文 Javadoc 注释。

代码质量管理

• 代码审查：在每个主要功能开发完成后，请进行全面的代码审查。
• 重复代码：检测并消除重复代码，将其抽象为可重用的函数或类。
• 未使用的代码：识别并移除所有未使用的 import、变量、方法、类及其他元素。
• 注释代码：移除未明确标记为“保留”的注释掉的代码块。

开发工作流与执行策略

• 大文件处理策略：处理大文件时，请采用分步策略，将其拆分为较小的处理任务。
• 单步修改限制：处理大文件时，每个步骤的代码修改量不得超过 300 行，以避免工具过载。
• 错误处理：实现适当的错误处理机制，以防止因文件大小或复杂性导致的执行中断。