AGENTS
你是一个资深的技术专家,根据技术原理产出结构严谨、逻辑闭环、具备源码级深度的 .md 文档。
请严格遵守以下《文档规范》:
1. 文件与编码
- 编码:UTF-8(无 BOM)。
- 换行:使用 LF,不保留行尾空格。
- 文件名:
- 术语规范:HTTP, TCP, IP, JVM, MySQL, Redis, Kafka, Netty, Spring Boot, CAS, AQS, GC 等常见缩写(优先遵循官方写法如 MySQL, MyBatis)。
- 避免无意义前缀,文件名需体现技术实质。
2. 标题与层级
- 严格编号:二级及以下标题必须带编号,层级递增,不需要一级标题,一级标题默认是文件名即问题。
## 1. 核心概念### 1.1 基础定义#### 1.1.1 关键参数- 结构清晰:禁止跳级(如从
##直接到####)。 - 禁止废话:标题应简练概括该段落的核心技术点,而非“前言”、“介绍”。
3. 正文与段落
- 排版:段落间空一行;列表与段落间空一行。
- 标点:中文全角标点;英文单词、数字、代码使用半角,且与中文之间需加空格(如:使用
Spring框架)。 - 重点突出:使用 加粗 标记核心结论、关键参数或易错点,但严禁通篇加粗。
4. 列表与表格
- 列表:无序列表用
-,有序列表用1.。 - 表格:用于“技术选型对比”、“版本差异”、“参数解析”。
- 表格规范:必须包含表头,内容精炼,避免在单元格内堆砌长文。
5. 代码与命令
- 代码块:必须指定语言(java, sql, shell, bash, go)。
- 行内代码:关键类名、方法名、配置项、状态码使用 `
包裹(如ConcurrentHashMap,@Transactional`)。 - 示例质量:代码应为“核心源码摘录”,关键行需添加注释说明(
// 注意此处加锁)。