智能代码文档一致性审核

幂简官方

1 浏览

0 试用

0 购买

Nov 12, 2025更新

本提示词专为代码审查场景设计，通过系统化分析代码实现与文档描述的匹配度，精准识别函数注释、参数定义与实现逻辑之间的差异。采用多维度检查机制，能够有效发现文档遗漏、参数不匹配、逻辑描述偏差等常见问题，并提供具体可行的改进建议。适用于API开发、代码维护、技术文档更新等多种场景，帮助开发团队降低维护成本，提升代码质量与文档准确性。

函数名称	问题类型	具体问题	改进建议	严重程度
calc_discount	参数不匹配	参数 min_payable 的文档默认描述为“默认不低于 0.01”，但函数签名默认值为 0.0，且代码仅在传入 None 时按 0.01 处理。	在 Args 中明确：min_payable 默认值为 0.0；当传入 None 时按 0.01 处理。示例描述可改为“min_payable (float	None, optional): 最低应付金额阈值，默认 0.0；若为 None，则按 0.01 处理”。
calc_discount	文档遗漏	代码显式支持 min_payable=None 的分支，但文档未说明该参数可为 None（且类型标注为 float，文档中未体现可为 None）。	在 Args 中将类型标注为“float	None（可选）”，并补充 None 的语义与处理方式。必要时在 Notes 中再次强调 None→0.01 的替代规则。
calc_discount	逻辑描述错误/易误导	rate 在文档中描述为“0-1之间”，给人以强制约束的印象，但代码仅校验非负，不限制上限（>1 也不会抛错）。	将参数说明调整为“建议取值范围 [0,1]，函数仅对负值进行校验，不对上限进行强制校验”。如需严格范围校验，请在文档中明确当前不会抛异常。	中
calc_discount	返回值说明不准确	文档称“保留两位小数”，但代码仅对折后价格部分 round(..., 2)；若最终取用 min_payable，返回值可能不是两位小数（例如传入 0.015）。	在 Returns 中说明：折扣价会四舍五入至两位小数；若触发最低应付规则，则返回 min_payable 的原值（不进行二次四舍五入）。如需统一两位小数，请在文档中特别说明当前行为不会强制格式化。	高
calc_discount	逻辑描述不完整	Notes 仅描述“先按 rate 计算折扣价，再与 min_payable 取较大值”，未提到先进行四舍五入以及 None→0.01 的处理顺序。	在 Notes 中补充完整流程：“先按 rate 计算折扣价并四舍五入至两位小数；将 min_payable 为 None 时视为 0.01；最后在折扣价与 min_payable 间取较大值。”	中
calc_discount	文档遗漏	未说明 min_payable 的取值未做非负校验（可以为负数），可能导致和“最低应付”直觉不一致。	在 Args 或 Notes 中补充：当前对 min_payable 未做非负校验，允许为任意实数；使用方应自行保证其合理性。	中
calc_discount	文档遗漏	min_payable 的单位未在文档中标注，amount 标注了“单位元”。	在 Args 中为 min_payable 增补单位“单位：元”。	低
calc_discount	异常说明边界不清	Raises 仅说明 amount 或 rate 为负数抛出 ValueError；未明确 rate>1 或 min_payable 取值异常不会抛错。	在 Raises 或 Notes 中补充边界说明：“当 rate>1 或 min_payable 为任意值时，函数不会抛出异常；仅当 amount<0 或 rate<0 时抛出 ValueError。”	低

函数名称	问题类型	具体问题	改进建议	严重程度
buildIndex	参数不匹配	options.locale 在注释中声明为“i18n 标识”，但在代码实现中完全未被使用，对结果无影响。	在 /docs/search-indexing.md#buildIndex 中明确说明：当前版本 locale 参数不会影响分词或统计结果，仅为预留字段；或补充其设计意图与未来用途。标注“当前未使用”。	高
buildIndex	文档遗漏	items 支持两种元素类型：字符串，或对象（使用 it.text；未定义时回退为空字符串）。文档未说明该输入数据结构。	在外部文档明确输入数据格式：items 为数组，其中元素可为 string 或 { text: string }；未提供 text 时视为 ''。给出示例。	高
buildIndex	参数不匹配	tokenize 文档声明取值 'char'	'word'，但代码对非法值会走 'word' 分支（非严格校验）。文档未说明这一回退行为。	在文档中补充：tokenize 允许值 'char' 或 'word'，当传入其他值时按 'word' 处理；建议给出表格或说明默认与回退。
buildIndex	文档遗漏	返回值语义不够明确：size 为唯一 token 的数量；stats.avgToken 为总 token 计数除以 items.length（当 items 为空时为 0）。文档未清晰说明计算方式和边界条件。	在返回值说明中明确：size 表示唯一 token 数；stats.avgToken = 所有项产生的 token 总数 / 项数，空数组时为 0。补充公式和示例。	中
buildIndex	文档遗漏	错误处理未记录：当 items 非数组时抛出 TypeError('items must be array')。	在文档中增加“错误与异常”小节，说明类型校验与抛出的异常类型与消息。	中
buildIndex	逻辑描述错误	文档将 locale 标注为“i18n 标识”，易让读者认为会影响分词或排序，但实现未使用。该描述与逻辑不一致。	将“locale: i18n 标识”改为“预留的国际化标识（当前实现不参与分词或统计）”。如需保留该参数，明确其无效性与未来用途。	高
buildIndex	文档遗漏	分词细节未说明：'char' 使用 Array.from(text)（按 Unicode code point，非用户感知的字素簇）；'word' 通过按空白分割，保留标点与大小写，不做归一化。	在文档中补充分词策略细节与限制：'char' 为 code point 粒度；'word' 按空白分割，不去除标点、不做大小写或 Unicode 规范化。说明与中文（默认 locale 为 zh-CN）场景下的行为。	中
buildIndex	性能	文档未说明复杂度与资源占用：算法时间复杂度 O(T)，内存随唯一 token 数增长（Map 存储所有唯一 token 及其频次）。	增加性能说明：时间复杂度与内存复杂度，提示大语料下 Map 的内存开销，并给出建议（如分批处理或限制输入大小）。	低
buildIndex	逻辑一致性	函数名与注释“构建搜索索引”可能引导期望产出可查询的索引结构，但返回值仅为摘要统计（size、avgToken）。需要与外部规范确认是否符合预期。	在外部规范 /docs/search-indexing.md#buildIndex 中明确功能定位：本函数仅构建统计摘要而非可查询索引；若外部规范要求可查询索引，需在文档中标注“不满足规范”并指向实现差异。	中
buildIndex	文档遗漏	默认参数未完整描述：tokenize 默认 'word'，locale 默认 'zh-CN'。	在参数说明中明确默认值，并给出调用示例（省略 options 的情况）。同时说明 locale 默认值目前不影响结果。	中

函数名称	问题类型	具体问题	改进建议	严重程度
parse_date	返回值类型不匹配	函数注解为返回 int，但代码在日期格式无效时返回 None；内联注释虽提到“无效格式返回 None”，但未在“输出”中明确返回类型为可选。	在“输出”段补充并明确返回类型：“返回：Unix 时间戳（秒），类型为 int；当 date_str 格式不合法时返回 None（int 或 None）”。同时在“异常”段重申返回 None 的条件。	高
parse_date	文档遗漏	未说明 tz 无效（未知时区或系统不支持）时的处理策略。代码会捕获异常并回退到 UTC。	在“异常”或“行为”段补充说明：“当 tz 无效或系统不支持该时区时，回退到 'UTC'，不抛出异常”。	中
parse_date	文档遗漏	参数 tz 的取值范围未明确。代码依赖 zoneinfo.ZoneInfo，要求使用 IANA 时区标识。默认值 'UTC' 未在注释中明确。	在“输入”段补充：“tz：IANA 时区标识（如 'UTC'、'Asia/Shanghai'），默认 'UTC'；当提供未知标识时回退到 'UTC'”。	中
parse_date	逻辑描述易误解	“行为: 解析为对应时区时间”表述含糊。代码通过 replace(tzinfo=z) 将输入字符串视为该时区的本地时间并标注，不进行跨时区转换（非 astimezone）。	在“行为”段精确描述：“将 date_str 作为 tz 的本地时间进行标注（通过设置 tzinfo），随后计算对应的 Unix 时间戳；不执行跨时区转换”。	中
parse_date	文档遗漏	时间戳的取整策略未说明。aware.timestamp() 产生 float，代码使用 int(...) 截断到秒。	在“输出”段补充：“时间戳以秒为单位，毫秒部分被截断（向下取整）”。	低
parse_date	文档遗漏	日期格式只提供示例，未明确具体的格式模板。	在“输入”段补充明确格式模板：“date_str 必须符合 '%Y-%m-%d %H:%M' 格式，例如 '2025-05-01 09:00'”。	低

解决的问题

为研发团队提供一键式“代码×文档一致性”体检，在迭代评审、发布前验证、接口维护与技术文档更新等关键节点，快速定位不一致点并给出函数级别、可落地的修改建议。以标准化流程与清晰结果清单，帮助团队缩短评审耗时、降低维护与沟通成本、减少线上风险，稳步提升交付质量与文档可信度。

适用用户

后端开发工程师

在合并前一键体检模块，发现参数、返回说明与实现差异；按函数级建议修补文档，减少代码评审反复与回归问题。

接口文档维护者（技术写作者）

同步版本更新时核对文档与最新实现，自动识别遗漏与过时描述，快速生成修改清单并与开发对齐，提高发布效率。

QA测试工程师

在提测前验证接口行为与文档声明一致；根据严重程度分级安排用例与重点回归，降低线上缺陷。

特征总结

• 一键对比代码与文档，轻松查出注释、参数、返回信息不一致，避免上线缺陷。

• 函数级精准定位问题，自动给出可执行的文档修改建议，节省审查与沟通时间。

• 支持多种语言与文档规范，跨团队统一标准，减少因风格差异导致的理解偏差。

• 自动识别文档遗漏、过时描述与逻辑偏差，生成清晰问题清单，帮助快速修复。

• 按严重程度分级提醒，优先处理高风险项，确保版本发布与交付更稳妥。

• 可设置检查深度与关注点，一键聚焦核心模块，避免无效拉通与重复返工。

• 版本发布前快速体检，提前发现接口变更与文档缺失，降低线上故障与客服压力。

• 只读审核不改代码，确保安全合规；输出结构化建议，便于复盘与团队协作。

如何使用购买的提示词模板

1. 直接在外部 Chat 应用中使用

将模板生成的提示词复制粘贴到您常用的 Chat 应用（如 ChatGPT、Claude 等），即可直接对话使用，无需额外开发。适合个人快速体验和轻量使用场景。

2. 发布为 API 接口调用

把提示词模板转化为 API，您的程序可任意修改模板参数，通过接口直接调用，轻松实现自动化与批量处理。适合开发者集成与业务系统嵌入。

3. 在 MCP Client 中配置使用

在 MCP client 中配置对应的 server 地址，让您的 AI 应用自动调用提示词模板。适合高级用户和团队协作，让提示词在不同 AI 工具间无缝衔接。

AI 提示词价格

￥20.00元

先用后买，用好了再付款，超安全！

在线免费用提示词

您购买后可以获得什么

✓

获得完整提示词模板

- 共 537 tokens

- 4 个可调节参数

{ 代码内容 } { 文档类型 } { 检查深度 } { 重点关注 }

✓

获得社区贡献内容的使用权

- 精选社区优质案例，助您快速上手提示词

购买

智能代码文档一致性审核

解决的问题