用途:为读者无法从名称、类型和代码结构可靠推断的行为补充文档,包括公共模块、类、函数、方法、协议与回调,以及参数语义、返回值/生成语义、异常、副作用、并发与缓存等。
主要能力:识别公共接口与非显而易见行为;按仓库既有 Google、NumPy、Sphinx 或项目自定义风格撰写最小必要文档;区分值得记录的内容(契约、不变量、单位、哨兵值、顺序、所有权、可变性、空行为、重试/回退)与通常无需记录的内容(名称与类型已自解释的私有辅助函数、普通赋值与循环、注解已表达的类型信息、无依据的推测性理由)。
使用方式:先阅读仓库说明、目标 Python 文件、邻近已文档化代码及 pyproject.toml 等文档/检查配置;确定范围内公共接口与非显而易见行为;添加最小文档或注释;除非用户要求重构,否则不修改可执行代码、签名、注解或格式;随后解析或编译改动文件,运行仓库配置的文档/检查/类型/测试命令,并检查 diff 确认仅字符串或注释变化。审查模式只报告不编辑;编辑模式只触碰请求的源文件及紧密耦合的文档元数据。
适用场景:公共 API 文档补全、代码审查中的文档检查、数据模型字段说明、长函数中稳定阶段的语义标题、需要解释分支顺序、不变量、外部约束或回退原因的内联注释。
限制:文档数量不是质量指标,过多注释反而增加维护成本;猜测的“为什么”注释有害;不应罗列所有底层异常以免造成虚假 API 保证;docstring 示例需小而确定并符合仓库 doctest 策略;生成文件、第三方代码与存根未经明确授权不应编辑;成功解析不能证明行为性声明成立。资料未提供具体安装命令、价格或平台信息。