使用 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中文網其他相關文章！