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

Agents.md 添加新的规范

可以让 AI 编码工具添加新的规范。

甚至可以把 阿里巴巴java开发规范写到 Agents.md 中。

可以注明是所有,这样就不用反复地在新的工作区中声明。

示例:
复制代码
在我的所有的Agents.md中添加这一条规范:XXX

在我的所有工作区中添加这一条规范:XXX

Agents.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 导向的工作流程。
相关推荐
代码方舟8 分钟前
O2O二手车交易平台B端车商管理后台:基于天远车信盟出险构建自动化车况评估网关
java·运维·人工智能·自动化
爱学堂IT分享10 分钟前
图灵Java互联网架构师六期
java·开发语言
坐吃山猪12 分钟前
【多线程】Semaphore使用
java·数据库·oracle·多线程
DO_Community30 分钟前
AMD旗舰GPU仅需4美元每小时,DigitalOcean上线Spot GPU实例
大数据·人工智能·agent·ai编程
秋名RG31 分钟前
Java 核心特性一览
java·开发语言
霸道流氓气质36 分钟前
Spring AI 技术细节:RAG QuestionAnswerAdvisor 设计与实现
java·人工智能·spring
斑马1391 小时前
Linux软件编程学习笔记(十二)——TCP并发服务器模型
java·服务器·网络
冬栈程序设计1 小时前
Springboot宿舍管理系统【670099】 -附源码(开箱即用)
java·毕业设计·springboot·课程设计·程序设计·大作业
2601_962284501 小时前
北京Java全栈开发培训 Web前端开发 软件测试就业培训班
java·软件测试·web前端·全栈开发·就业培训
qiaosaifei2 小时前
JAVA老项目中有大量的类名_编译时报找不到符号错误
java·开发语言