AI编程 -- Agents.md 的简单示例

Agents.md 添加新的规范可以让 AI 编码工具添加新的规范。甚至可以把 阿里巴巴java开发规范写到 Agents.md 中。可以注明是所有这样就不用反复地在新的工作区中声明。示例在我的所有的Agents.md中添加这一条规范XXX 在我的所有工作区中添加这一条规范XXXAgents.md 示例以下是一个 非常简单的 Agents.md 示例。## 全局开发规范 除非项目中存在更具体的约束否则以下规则适用于所有工作区。 ## 代码规范 - 非必要不要修改其他人编写的代码。 - 尽量不要在 for 循环中查询数据库。 - 使用异步处理解耦耗时较长的业务逻辑。 - 不要使用魔法值应定义常量或枚举。 - 不要在代码行末尾添加注释。 - 方法级注释和行内注释使用中文日志内容使用英文。 - 打印日志尽量使用debug级别错误日志使用error级别。 - 请求 DTO 字段可能存在空值语义时应避免使用 Java 基本数据类型。 - 初始化对象时优先使用无参构造方法。 - 数据库查询条件和过滤逻辑应放在 SQL 中不要先查询大量数据再在 Java 中过滤。 - 如果类中已经使用 Data 等 Lombok 注解不要重复手写 Getter 和 Setter。 - 批量更新和批量删除必须分批处理批次大小应通过配置项控制默认值为 1000。 - 建议在方法上方添加简洁的 Javadoc 风格注释例如 java /** * 简要说明。 */ ## sql 规范 - SQL 尽量简单避免复杂慢 SQL。 - 不要使用三个表及以上的 join。 ## 包结构规范 - DTO 和 VO 默认不要放在 common 模块中应优先放在对应服务所属的业务模块中。 ## 分页规范 - 使用项目已有的分页参数。 - 使用项目已有的分页结果类型。 ## Skill 使用偏好 - 使用 clean-code / Java clean-code 指南保证代码质量。 - Java 代码审查使用 java-code-review。 - 调试问题使用 debugging-strategies。 - 编写或优化 SQL 时使用 sql-optimization-patterns。 - 适用时单元测试采用 TDD 导向的工作流程。