(整理自完整版 commands/doc.md 实测文本,非本次新实测;/doc 不在 Lite 免费版、只在完整版。)
函数写完了,注释只有“计算折扣”四个字;项目没有 README,别人 clone 下来不知道怎么跑;API 变了,文档还是上个季度的——/doc 只做一件事:写能跑起来的中文文档,不写“看起来很全、实际跑不通”的文档。
先定读者。写之前问一句“这文档给谁看”(自己/同事/外部用户),读者不同写法不同;说不清就默认“三个月后的自己”。类型分三路:注释、README、API,写法各不相同,不要一套模板硬套。
注释三原则:
- 说“为什么”不说“是什么”。代码已经说明了是什么,注释要补的是业务原因——比如为什么 gold 是 0.8、level 缺失时默认 normal 的约定从哪来。
- 复杂算法给复杂度与参考链接。只贴代码不给复杂度,等于把推导成本留给下一个读者。
- TODO 必须带 owner 和日期,如
# TODO(张三, 2026-11-01): 补充分位舍入。不带日期的 TODO 一律删掉或补上,否则就是永远没人管的债。
README 五件套(缺一不可):一句话介绍、安装步骤(可复制的命令)、最小可用示例、常见问题(3 条起)、许可证/联系方式(不写裸邮箱,用项目主页链接)。缺了安装步骤或最小示例的 README,新人第一步就卡住。
API 一路:每个端点写方法+路径+参数表(含必填/选填与示例值)+返回示例+错误码表;参数改了,文档当天改,不要攒到季度末一起改。
中文优先:文档主体用中文写;代码标识符、错误码、专有名词保留英文原文,不硬翻(如“句柄”不如直接写 handle)。中英机翻腔比不写更难读。
最后一步最关键——校验:写完按文档里的安装步骤在干净目录真实走一遍,走不通就改文档。跑不通的文档等于没有文档,跑不通的安装步骤是文档里最常见的谎言。输出最后要附“校验记录”:在哪台机器/目录按步骤走过、是否一次通过。
什么时候不要用:代码还没定稿——文档跟着半成品改是双倍工作,先定代码;想把所有实现细节都写进文档——文档写“怎么用”和“为什么”,不写“怎么实现”(实现看代码);写完不校验——那就别发。
示例要点(取自 doc.md 的输入输出示例):输入是 /doc orders.py,类型:注释;输出要点是给 calc_discount 补“为什么 gold 是 0.8”的业务注释,给 batch_settle 补“level 缺失时默认 normal”的约定注释,给 TODO 补 owner+日期。
免费先试:Lite 免费版含 /review、/commit、/test 三条命令,双兼容 Claude Code 与 Codex CLI,见 Lite 仓。
完整版含 /doc 在内的 10 条命令,早鸟 ¥9.90(限前 100 份)/正式 ¥19.90,付款后 12 小时内私信交付,7 天无理由退款。国内账号风控提示:优先用 Codex。
链接(文末三链接):
