Cursor提示词：旧代码整理文档的篇幅与格式控制实操

你是否经常遇到这种困境：用Cursor生成代码文档时，输出要么冗长如学术论文，要么空洞仅剩函数签名，最终仍需手动大幅调整？核心症结在于提示词设计——AI无法揣测你的精准意图，唯有预先划定明确边界，才能获得稳定、可复用的文档。

核心法则有三：篇幅由指令控制，格式由锚点锁定，内容由边界限定。将这三项要素嵌入提示词，文档质量即可实现量级跃升。

精准控制文档篇幅：三档开关法

在提示词开头明确声明所需篇幅档位，AI将依据指令压缩或扩充内容密度。若不加设定，默认以中等长度自由生成，输出结果极不稳定。

第一档：精简档
专用于代码注释或PR描述。仅需添加一条指令：
“输出限制在120字以内，仅包含核心功能、关键输入/输出参数、1个典型调用示例。”

第二档：标准档
适用于团队Wiki页。追加指令：
“输出长度控制在400–600字，分三部分：① 用途一句话定义；② 输入参数表（含类型、是否必填、示例值）；③ 执行流程图解（纯文字箭头→描述，不超过5步）。”

第三档：详实档
适合交接文档或新人培训。追加指令：
“输出不少于900字，必须包含：背景动机（为什么创建该函数）、边界条件处理逻辑、3种异常场景及对应返回、与上下游模块的调用关系图（缩进+破折号表示层级）。”

锁定文档格式：用结构锚点替代模糊要求

切勿写“请用Markdown格式”，这种指令等于空谈——AI可能混用#与##，也可能遗漏表格边框。必须给出可识别、可校验的结构信号。

第一步：强制一级标题锚点
在提示词末尾追加：“所有输出必须以‘## 功能说明’为唯一一级标题，禁止出现‘#’或‘###’。”

第二步：参数表必须带固定字段标头
写明：“参数列表必须使用Markdown表格，表头严格为：| 参数名 | 类型 | 必填 | 默认值 | 说明 |，缺一不可，空值填‘—’。”

第三步：流程描述禁用编号
强调：“执行步骤用‘→’串联成单行，例如‘接收request → 校验token → 查询DB → 构造response → 返回JSON’，禁止使用1.2.3.或①②③。”

关键警示：若提示词中只写“用表格展示参数”而未规定表头字段，Cursor大概率自创列名（如“字段”“数据类型”“备注”），导致后续无法用脚本批量提取——必须将表头字符串原样写死。

防止格式污染：清除AI惯性冗余

第一步：阻断解释癖
添加硬性约束：“禁止出现‘该函数的作用是…’‘需要注意的是…’‘综上所述…’等引导性/总结性句式，所有内容必须为客观陈述。”

第二步：砍掉模板套话
写入：“删除所有类似‘本文档由AI生成’‘仅供参考’‘如有疑问请联系’等免责声明，一字不留。”

第三步：格式洁癖指令
追加：“输出中不得出现任何反引号(`)、三个以上连续换行、中文全角空格、非ASCII符号（如→除外），发现即重写。”

来源：互联网