name: 函数文档字符串 description: 为函数编写简洁的文档字符串。在初级开发者需要帮助描述输入、输出和错误时使用。
函数文档字符串
目的
为函数编写简洁的文档字符串。
输入请求
- 函数签名和行为。
- 边缘情况或错误条件。
- 项目文档字符串风格指南。
工作流程
- 用一句话描述目的。
- 列出参数及其类型和含义。
- 说明返回值和错误条件。
输出
- 项目风格的文档字符串块。
质量标准
- 保持措辞精确和简洁。
- 匹配项目格式化风格。
函数文档字符串编写 function-docstrings
这个技能用于帮助开发者编写函数文档字符串，特别适用于初级开发者，涉及描述函数输入、输出和错误条件，匹配项目风格，以提高代码可读性和维护性。关键词：函数文档、文档字符串、代码注释、软件开发、编程实践。