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 导向的工作流程。
相关推荐
小羊没烦恼!4 天前
微服务化的基石——持续集成
java·大数据·word·powerpoint·.net
子兮曰4 天前
Jev 爆发一周:7 秒 Agent 背后的 System One 生态与三场争议
前端·后端·ai编程
俊昭喜喜里4 天前
java中的继承和多态的区别
java
小羊没烦恼!4 天前
初探性能优化——2个月到4小时的性能提升
java·开发语言·windows·算法·c#
譕痕4 天前
JSONObject与JSONArray封装数据格式区别
java·json
胡写代码4 天前
别再前后端各写一套表单校验了
java·后端
小鱼能吃糖4 天前
缺陷修复总览 · mall电商项目:5类缺陷,1个病根,4个业务域
java·电商
1点东西4 天前
做了近两年的Agent开发,其实真正要学的就是这五件事
llm·agent·ai编程
七牛云行业应用4 天前
Qwen-Image-2.1 开源部署完整指南:Diffusers、ComfyUI 与推理服务
ai编程
此时不提桶,更待何时4 天前
01-06-A-JVM排查实战详解
java·jvm