Générer un commentaire JSDoc pour votre fonction à l'aide d'OpenAI.

Cet article est inspiré du package interne de Remotion, ai-improvements. Ce package interne est utilisé pour améliorer/générer des commentaires JSDoc et se connecter à la console pour une fonction dans le code source de Remotion.

Ce cas d'utilisation est assez différent car vous utiliseriez normalement le code source et laisseriez OpenAI générer la documentation de l'API, mais à la place dans Remotion, ce package interne utilise l'API OpenAI pour générer un commentaire JSDoc pour une fonction en utilisant la documentation de l'API et le code source.

Nous examinerons en détail comment ce package est configuré :

1. improve-docs.ts
2. générer-jsdoc

Améliorer les documents

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 a les importations ci-dessus. generateJSDocTask est importé du dossier « tâches ».

selon la tâche, vous pouvez soit générer un JSDoc, soit trouver des erreurs.

Générer du JSDoc

generate-jsdoc.ts utilise l'API openai et propose des invites comme indiqué dans l'image ci-dessus.

Veuillez noter que cela n'écrira que le JSDoc généré sur la console. Serait-il possible d'écrire ces commentaires JSDoc par programme dans le fichier ? Pas sûr, mais cela vaut la peine de lire la documentation AST pour voir s'il existe une API disponible pour ajouter des commentaires JSDoc juste au-dessus du nom de la fonction ou de la classe. ts-morph est connu pour être utilisé dans shadcn-ui/ui pour manipuler le code source au niveau AST.

À propos de nous:

Site Internet : https://thinkthroo.com/

Github : https://github.com/thinkthroo/thinkthroo (Donnez-nous une étoile !)

Créez gratuitement des projets open source à partir de zéro

Améliorez les compétences de codage de votre équipe.

Besoin d'aide pour un projet ? Contactez-nous à thinkthroo@gmail.com

Références :

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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!