使用 OpenAI 为您的函数生成 JSDoc 注释。

本文的灵感来自于 Remotion 的内部包 ai-improvements。该内部包用于改进/生成 JSDoc 注释并登录控制台以获取 Remotion 源代码中的函数。

这个用例非常不同，因为您通常会使用源代码并让 OpenAI 生成 API 文档，但在 Remotion 中，这个内部包使用 OpenAI API 使用 API 文档和源代码为函数生成 JSDoc 注释。

我们将从高层次上看一下这个包是如何配置的：

1. 改进-docs.ts
2. 生成-jsdoc

改进文档

import path from "path";
import { OpenAI } from "openai";
import { getApis } from "./map-over-api";
import { findMistakes } from "./tasks/find-mistakes";
import { generateJSDocTask } from "./tasks/generate-jsdoc";

improve-docs.ts 具有上述导入。 generateJSDocTask 是从“tasks”文件夹导入的。

根据任务的不同，您可以生成 JSDoc 或查找错误。

生成JSDoc

generate-jsdoc.ts 使用 openai API，有如上图所示的提示。

请注意，这只会将生成的 JSDoc 写入控制台。是否可以以编程方式将这些 JSDoc 注释写入文件中？不确定，但值得阅读 AST 文档，看看是否有任何 API 可用于在函数或类名称上方添加 JSDoc 注释。 ts-morph 已知在 shadcn-ui/ui 中用于在 AST 级别操作源代码。

关于我们：

网站：https://thinkthroo.com/

Github：https://github.com/thinkthroo/thinkthroo（给我们一颗星！）

免费从头开始构建开源项目

提高团队编码技能。

需要项目帮助吗？请通过 thinkthroo@gmail.com 联系我们

参考：

https://github.com/remotion-dev/remotion/tree/main/packages/ai-improvements

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/improve-docs.ts

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/tasks/generate-jsdoc.ts

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/tasks/find-mistakes.ts

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/map-over-api.ts

https://github.com/remotion-dev/remotion/blob/main/packages/docs/src/data/articles.ts

以上是使用 OpenAI 为您的函数生成 JSDoc 注释。的详细内容。更多信息请关注PHP中文网其他相关文章！