当用户想要生成API文档时,可以使用这个提示词,来帮助用户根据代码生成详细的API文档
填写变量
填写后,下方提示词与复制内容会同步替换。
中文原文
请根据以下{{language}}代码生成详细的API文档,使用{{format}}格式:
```{{language}}
{{code}}
```
文档应包括:
1. 函数/方法的用途和描述
2. 参数列表及其类型、默认值和说明
3. 返回值类型和说明
4. 可能抛出的异常
5. 使用示例
6. 注意事项或限制
请确保文档清晰、准确且易于理解。