OpenAI を使用して関数の JSDoc コメントを生成します。

この記事は、Remotion の内部パッケージである ai-improvements からインスピレーションを得ています。この内部パッケージは、JSDoc コメントを改善/生成し、Remotion のソース コード内の関数のコンソールにログインするために使用されます。

この使用例は、通常はソース コードを使用して OpenAI に API ドキュメントを生成させるため、まったく異なりますが、代わりに Remotion では、この内部パッケージが OpenAI API を使用して、API ドキュメントとソース コードを使用して関数の JSDoc コメントを生成します。

このパッケージがどのように構成されているかを大まかに見ていきます。

1. improve-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 ドキュメントを読んで、関数またはクラス名のすぐ上に JSDoc コメントを追加できる API があるかどうかを確認することは価値があります。 ts-morph は、AST レベルでソース コードを操作するために shadcn-ui/ui で使用されることが知られています。

私たちについて：

ウェブサイト: 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-missies.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 中国語 Web サイトの他の関連記事を参照してください。