代码文档一致性审核专家

幂简官方

175 浏览

15 试用

3 购买

Dec 10, 2025更新

本提示词专为代码审查与文档维护场景设计，通过系统化对比代码实现与文档描述，精准识别函数注释、参数定义、返回值说明及逻辑描述之间的差异。它能有效发现文档遗漏、参数不匹配、逻辑偏差等常见问题，并提供具体可行的改进建议与严重程度评估。适用于API开发、代码重构、版本发布前检查及技术文档同步更新，帮助开发团队提升代码质量与文档准确性，降低维护成本。

函数名称	问题类型	具体问题	改进建议	严重程度
IsoDateParser.parse	返回值类型不匹配	JavaDoc标注“返回 Date 或 null”，而实现返回的是 Optional，且不会返回 null 或 Optional.empty。	将 @return 修改为“返回 Optional；当解析失败时抛出异常（见 @throws），不会返回 null 或 Optional.empty”。	高
IsoDateParser.parse	功能逻辑描述错误	注释首句写“解析为Date”，与实现实际解析为 ZonedDateTime 不符。	将开头描述改为“解析 ISO 8601 字符串为 ZonedDateTime（包装于 Optional 中），并可按传入的 ZoneId 做同一瞬时的时区转换”。	高
IsoDateParser.parse	参数名称不匹配	@param 使用了“zone”“lenient”，而方法签名为“tz”“strict”。	将 @param 名称调整为与签名一致的“tz”“strict”。	高
IsoDateParser.parse	参数类型不匹配	文档将“zone/时区ID”描述为字符串（如 "Asia/Shanghai"），而代码第二参数类型为 java.time.ZoneId。	将 @param tz 的说明改为“ZoneId，可为 null”；示例中用 ZoneId.of("Asia/Shanghai")。	高
IsoDateParser.parse	参数语义与默认值描述不一致	文档称“lenient 是否宽松解析，默认 true”，而实现是 boolean strict（严格模式）、无默认值机制。	将参数说明改为“strict：严格模式，true 时年份小于 1900 将抛出 DateTimeException；false 时不做年份下限校验”。删除/更正“默认值”为调用方需显式传参。	高
IsoDateParser.parse	默认时区行为描述不一致	文档称“时区ID为空时默认 UTC”，而实现是 tz 为 null 时不变更时区（保留 iso 中自带的偏移/时区）。	将 @param tz 的说明改为“为 null 时保留 iso 字符串中自带的偏移/时区；非 null 时使用 withZoneSameInstant 进行转换”。移除“默认 UTC”的表述。	高
IsoDateParser.parse	异常抛出说明不准确/不完整	文档仅写“当 iso 格式不合法时抛出 IllegalArgumentException”。实现实际可能抛出：IllegalArgumentException（iso 为 null/空串）、DateTimeParseException（格式不合法时 ZonedDateTime.parse 抛出）、DateTimeException（strict 且年份<1900）。	在 @throws 中分别列出：IllegalArgumentException（iso 为 null 或空字符串）、DateTimeParseException（iso 格式不合法）、DateTimeException（strict 为 true 且年份小于 1900）。	高
IsoDateParser.parse	失败处理与返回策略描述不一致	文档写“无法解析时返回 null”，实现是解析失败抛异常，且方法始终返回 Optional.of(...)。	将“无法解析时返回 null”改为“无法解析时抛出 DateTimeParseException”，并明确方法不会返回 null 或 Optional.empty。	高
IsoDateParser.parse	使用示例不匹配	示例使用第二参为字符串 "Asia/Shanghai"（签名需要 ZoneId），第三参语义对应“宽松/lenient”而实现是“strict”，且未体现 Optional 返回值及可能抛出的异常。	将示例改为使用 ZoneId（如 ZoneId.of("Asia/Shanghai")），第三参数按 strict 语义说明；示例中展示接收 Optional 的用法，并注明可能抛出 DateTimeParseException/DateTimeException。	高
IsoDateParser.parse	术语/类型表述不准确	文档多处提及“Date”，与实现使用 java.time（ZonedDateTime）不一致，容易误导为 java.util.Date。	将所有“Date”替换为“ZonedDateTime”（或“java.time.ZonedDateTime”以更明确），避免与 java.util.Date 混淆。	中
IsoDateParser.parse	输入格式约束说明遗漏	文档未说明 iso 需包含时区/偏移信息；ZonedDateTime.parse 对无偏移/时区的字符串会抛异常。	在功能说明中补充：iso 字符串应包含 'Z'、显式偏移（如 +08:00）或时区信息，否则会抛出 DateTimeParseException。	中
IsoDateParser.parse	时区转换方式说明不足	文档未说明采用 withZoneSameInstant 进行同一瞬时的时区转换（不改变时间点）。	在参数或功能描述中补充：当提供 tz 时使用 withZoneSameInstant 进行转换，保持瞬时不变，仅改变表示的时区。	低

函数名称	问题类型	具体问题	改进建议	严重程度
httpGet	参数类型不匹配	JSDoc 将 url 标注为 string，但代码签名为 URL。	将 @param {string} url 调整为 @param {URL} url，并在描述中明确需要 URL 实例。	高
httpGet	参数结构不匹配	JSDoc 将 timeout、retries 写成函数的独立参数；代码实际为第二个参数 options 对象，包含属性 timeout、retry。	将参数文档统一为 @param {Object} [options]，并补充子属性：@param {number} [options.timeout=2000]、@param {number} [options.retry=2]。	高
httpGet	参数命名不一致	文档使用 retries（复数），代码属性为 retry（单数）。	统一文档用词为 retry，与代码属性名保持一致。	高
httpGet	参数默认值不一致	文档声明 timeout=1000、retries=3；代码默认 { timeout: 2000, retry: 2 }，且超时回退为 2000。	将默认值说明改为 timeout 默认 2000、retry 默认 2，并明确当 options 或其属性未提供时的默认行为。	高
httpGet	返回值类型不匹配	文档声明 @returns {Promise} 并称“响应文本”；代码返回 Promise，未提取文本。	将 @returns 改为 {Promise}，并说明需通过 Response.text()/.json() 等方法读取内容。	高
httpGet	错误行为描述不准确	文档称“失败时抛出 Error”；代码对非 2xx 并不抛错，仅在网络错误/超时（Abort）时 reject。	在文档中澄清：仅在请求被中止或网络失败时返回拒绝（可能抛出 DOMException: AbortError/TypeError），对非 2xx 不会抛错。可在 @throws 中列出可能错误类型。	高
httpGet	功能逻辑描述错误	文档称“发起HTTP GET请求并缓存结果”且“更新内存缓存与本地存储”；代码无缓存或本地存储相关实现。	删除缓存与本地存储相关描述，改为“发起 HTTP GET 请求，支持超时中止”。	高
httpGet	使用示例错误	示例传入字符串路径且暗示返回为文本；与签名（URL 类型）和返回 Response 不符。	将示例改为传入 URL 实例，并展示 Response 的使用方式（如读取 text/json），例如：await httpGet(new URL('/health', location.origin));	高
httpGet	未实现的重试功能	文档声明“失败时重试次数”，但代码未实现重试逻辑，options.retry 未被使用。	在文档中移除“重试”相关说明或标注“暂未实现”，避免给出误导性默认值。	高
httpGet	副作用说明错误/遗漏	文档称会“更新内存缓存与本地存储”（不存在）；且未说明会创建定时器并在超时中止请求。	更新 @remarks：说明会在超时后中止请求并清理定时器；明确无缓存/本地存储写入。	中
httpGet	依赖关系遗漏	文档未说明依赖全局 fetch 与 AbortController 以及环境要求。	在 @remarks 中补充依赖与环境要求（浏览器或 Node.js 18+，或需相应 polyfill）。	中

解决的问题

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

适用用户

后端开发工程师

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

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

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

QA测试工程师

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

特征总结

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

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

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

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

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

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

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

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

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

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

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

2. 发布为 API 接口调用

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

3. 在 MCP Client 中配置使用

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

AI 提示词价格

￥30.00元

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

在线免费用提示词

您购买后可以获得什么

✓

获得完整提示词模板

- 共 537 tokens

- 4 个可调节参数

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

✓

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

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

购买

代码文档一致性审核专家

解决的问题