文档字符串生成器技能

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

我做什么

我按照行业标准生成特定于语言的文档字符串和文档: 检测语言:分析文件扩展名和项目结构以确定语言 检测文档字符串样式:识别代码库中现有的文档字符串约定 生成文档字符串:按照语言约定创建适当的文档字符串 支持多种格式:

什么时候用我

在以下情况下使用此工作流程: 在 Python、Java、TypeScript 或 C# 中实现新函数、类或方法 重构代码并更新文档 创建新 API 或公共接口 遵循文档最佳实践和行业标准

先决条件

源代码文件(.py、.java、.ts、.tsx、.cs、.csx) 读写文件的文件权限 了解首选文档字符串样式(可选,可以自动检测) 对于工作流集成:已初始化 Git 存储库

蟒蛇

标准:符合 PEP 257 支持的样式:Google 样式(推荐用于大多数项目) NumPy 样式(用于科学计算) Sphinx/reST 样式(用于文档生成)

爪哇

标准:Javadoc 支持的标签: @param - 参数文档 @return / @returns - 返回值文档 @throws - 异常文档

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@tomevault-io · 未声明许可证
上下文用量评级
中等消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
Python >=3.5
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:检测语言

分析文件以确定编程语言:

02
第 2 步:检测文档字符串样式

分析代码库中现有的文档字符串以保持一致性:

03
步骤 3:分析函数/方法

提取函数签名并确定文档字符串需求:

04
第 4 步:生成文档字符串

根据语言和风格生成适当的文档字符串:Python(Google 风格)Java(Javadoc)TypeScript(JSDoc)C#(XML 文档)

05
第5步:更新文件

将文档字符串插入文件中的正确位置:

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。