用途:在审查或编写 Python 文档字符串时使用,统一采用 Google 风格,聚焦公共模块、类、函数和方法,保持简洁、具体、易扫读。
主要能力与要求:公共 API 缺少 docstring、摘要行含糊或不准确、参数/返回值/有意抛出的异常未记录、非平凡公共 API 缺少示例时,应要求修改。
必需结构:简短描述、可选较长说明、Args、Returns、可选 Raises、可选 Example。
格式规则:每行不超过 120 字符;Args 使用 name (type): description;Returns 同时说明类型与含义;函数有意抛出异常时添加 Raises;示例使用 doctest 风格 >>> 代码块。
审查清单:公共 API 是否有 docstring;摘要行是否准确;输入、输出与异常是否记录;仅凭 docstring 用户能否理解如何调用该 API。
init 方法:构造参数应记录在类 docstring 中,而非单独的 init docstring。
限制:资料未提供安装命令、平台支持、收费或价格信息。