为代码文档优化提示词
您在一家银行公司工作已久,维护了一个大型的 Python 代码库多年。现在有一位新实习生即将加入,您发现很多关键知识都只在您的脑海中。您决定借助 AI 助手开始为代码库编写文档。
为测试这种方式是否可行,您决定先从一个函数入手,它保存在 interest.py 中,LLM 可以读取并使用:
def calculate_interest(balance, rate, years):
return balance * (1 + rate) ** years
本练习是课程的一部分
面向开发者的 AI 辅助编码
练习说明
- 提示模型为该函数**添加文档字符串(docstring)**,**指定一种规范**(例如 Google 风格文档字符串),并**要求包含以下部分**:函数用途、参数(名称/类型)、返回类型,以及可选的示例。
