代码解释模板
代码解释模板
解释下面的代码，按四段输出：
1) 一句话：它做什么
2) 逐段逻辑：每段 2-3 句
3) 关键细节：边界条件、副作用、复杂度
4) 潜在问题：异常与维护风险
读者是有经验的工程师，省略语言基础语法说明。
代码：<code>……</code>| 分层 | 四段结构把结论与细节分开，便于按需阅读 |
|---|---|
| 读者 | 声明读者水平，避免堆砌基础语法说明 |
| 严谨 | 不确定的行为标注“需运行验证”而不是直接断言 |
本包目录（290 条）
提示词基础40 条模式与框架50 条
任务型写法50 条
- 结构化字段抽取（JSON 输出）
- 文本分类提示基本写法
- 摘要任务基本写法
- JSON 输出模式与围栏约定
- 代码生成提示写法
- 意图识别任务写法
- 先定 Schema 再写抽取提示
- 基于资料作答（带引用）
- 标签体系定义与收敛
- 翻译任务基本写法
- 命名实体抽取（NER 式提示）
- 先大纲后成文（分步写作）
- 二分类与阈值处理
- 会议纪要摘要写法
- 代码评审提示写法
- 结构化摘要（结论+要点+数字）
- 多标签分类写法
- 长文分层摘要（分块后汇总）
- 技术文档写作（步骤式）
- 工单分诊与优先级判定
- 待办抽取与责任归属
- 情感分类任务写法
- 嵌套对象与明细数组抽取
- 日志解析为结构化字段
- 摘要保真约束（防添加原文外信息）
- 商务邮件写法（先结论后背景）
- 代码解释写法
- 垃圾与违规内容分类
- 原文片段引用式抽取
- 术语表约束的翻译
- 分类结果与原因的输出顺序
- 缺失字段与 null 约定
- 按问题定制摘要
- 产品与功能简介写作
- 解题步骤与结果分离（数学题）
- 不确定样本的弃权机制
- 文本转表格抽取
- 表格输出写法
- 字段级校验规则（枚举/范围/正则）
- 字段归一化与单位统一
- 文风模仿与风格约束
- 精简压缩改写
- 文体与语气适配翻译
- XML 标签结构化输出
- 抽取失败的回传修复循环
- 语气转换改写（正式化/口语化）
- 保留标记与格式的翻译
- CSV 输出与转义约定
- 扩写与细节补全
- 回译检查翻译质量
代码解释写法
解释代码按层次来：一句话作用→逐段逻辑→关键细节（边界/副作用）→潜在问题；面向读者水平决定详略。
易错点
- 不限定篇幅时逐行注释，输出又长又浅；按段组织更有效
- 语义有歧义处（如浮点比较）模型可能给出错误断言；关键结论要自行验证
数据来源与参考
- Google 技术写作课程：面向读者的解释性写作原则