ChatGPT code-documentation 技能:根据实际行为编写函数文档字符串
EnglishChatGPT 安装步骤
- 在支持创建技能的 ChatGPT 工作区打开「插件 → 技能 → 创建 → 使用编辑器创建」。
- 对照固定版本 GitHub 原文,在编辑器新建技能,将 `code-documentation` 的纯文本工作流程改写为技能说明。
- 保存后,在新对话输入 @ 并选中刚创建的技能,再用示例试用。
中文摘要
从给定代码和样例确认函数用途、参数、返回值和边界条件,再按项目指定格式写文档。
SKILL.md 中文导读
可复现示例
手动选择 code-documentation,按下面虚构函数契约写 Python 文档字符串。使用提供的行为和样例。
style preference `Google-style docstring`
function `tile_labels(rows)` returns every nonempty value in original order
actual sample `rows=["North", "", "West"]` | observed `result=["North", "West"]` | empty input gives `result=[]`工作步骤
- 读函数签名、行为说明和运行样例。
- 按项目指定风格整理参数、返回值与示例。
- 逐一核对声明的边界条件和异常。
验收方法
为 `tile_labels(rows)` 添加 Google 风格文档字符串,写明非空项保持原顺序。示例包含 `result=["North", "West"]`;空输入为 `result=[]`。
GitHub 原文 · 更新日期
适用环境
支持创建技能的 ChatGPT 工作区。示例仅使用下方已给出的纯文本材料。
常见问题
源码没展示异常时,文档要怎么写?
根据给定代码和观测记录写可确认的行为,异常条目只写能核实的情况。
相关指南
相关推荐
accessibility-checker 技能
lexicalninja/my-little-scrum-team
architecture-reviewer 技能
lexicalninja/my-little-scrum-team
best-practices-checker 技能
lexicalninja/my-little-scrum-team
bug-detector 技能
lexicalninja/my-little-scrum-team
ChatGPT changelog-generator 技能:把变更清单整理成更新日志
lexicalninja/my-little-scrum-team
ChatGPT code-style-analyzer 技能:生成代码风格问题清单
lexicalninja/my-little-scrum-team