¥
立即购买

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

免费试用多模型对比变量与模板化文本输出
完整提示词模板
¥30.00

提示词变量

正在加载表单组件...

提示词生成结果

📝
暂无试用结果

变量说明

  • 代码内容
    需要审核的完整或部分源代码,包含函数定义及其注释
    示例:“def calculate_sum(a, b): '''计算两数之和。 Args: a (int): 第一个加数 b (int): 第二个加数 Returns: int: 两数之和 ''' return a + b”
  • 文档类型
    需要检查的文档类型
    示例:“函数Docstring”
  • 检查深度
    检查的详细程度和范围
    示例:“标准检查(包含功能逻辑)”
  • 重点关注领域
    需要特别关注的检查领域
    示例:“参数名称与类型,返回值类型”

使用场景案例

  • ISO日期解析审
    Java方法含JavaDoc,核对参数命名与类型、返回Optional及异常。
  • HTTP请求JSDoc
    TS函数含JSDoc,核对URL类型、默认值、返回与缓存声明。