documentation - 生成 Google 风格文档和注释
为代码创建 Google 风格的文档字符串和完整文档。
标签
更新于: 2026-02-12能力
典型输入
典型输出
该技能可以做什么
- 使用 Google 风格文档字符串
- 编写模块级文档字符串
- 记录函数签名
- 添加类型提示
- 创建 README 文件
- 生成 API 文档
- 包含架构图
- 记录环境变量
- 添加弃用警告
- 使用 Sphinx 或 MkDocs
- 包含可执行示例
- 记录错误情况
- 添加参见引用
- 包含性能说明
- 记录线程安全
- 使用一致术语
- 包含更新日志
输入
- 源代码
- 配置文件
- 环境变量
输出
- 代码中的文档字符串
- README.md 文件
- API 文档
- 架构图
要求
- Python 环境
- 文档工具 (Sphinx/MkDocs)
