AI 智能体应用案例

今日新增

44全部 189 条

共 189 条,第 1–20 条

开发·编程实践示例

读取Python文件并起草README和函数说明

作者读取了函数和类的结构,并单独创建了带有使用指南文档和说明的Python文件。

使用方法

  1. 作者通过--file指定目标文件,并在--format中选择readme、docstrings或both。
  2. 程序提取了函数和类的结构,然后让模型编写安装方法、使用示例和API说明。在函数说明模式下,作者将完整代码传递给模型。
  3. 文档以README_模块名.md保存,带有说明的代码以documented_文件名保存。不会直接覆盖原始文件。

结果

这是一个生成包含文档和函数说明文件的实现示例。不会自动验证生成代码的功能保留或文档中的示例。

注意事项

在生成README时,传递给模型的代码正文限制为前3000个字符。对于较长文件,后部的功能可能会遗漏在文档中,因此需要单独检查。

来源

GitHub 原文 ↗

示例提示词 · LangChain

请为[Python模块]起草README和函数说明。参考agents/16-documentation-writer的结构提取和文档生成代码,整理Python环境和模型API设置。结果请保存到[空输出文件夹]。

请根据代码实际的函数名、输入值、返回值和异常进行说明,不要创建未公开的安装命令或环境变量。原始README路径仅传递代码正文的前3000个字符,因此对于较长的文件,请确认是否有遗漏部分并分段读取补充。带有说明的代码请与原文件分开保存。

请用小型模块测试同步、异步函数、默认值和异常。请在工作副本中运行文档中的示例,并与原始文件比较,确保除了函数说明外功能无变化。结果包括README、带说明的文件、变更对比和运行记录。尚未运行的使用示例请勿标记为已验证,并区分本次补充的长文件处理和验证范围。