Generieren eines JSDoc-Kommentars für Ihre Funktion mit OpenAI.

Dieser Artikel ist vom internen Paket von Remotion, ai-improvements, inspiriert. Dieses interne Paket wird verwendet, um JSDoc-Kommentare zu verbessern/generieren und sich in der Konsole für eine Funktion im Quellcode von Remotion anzumelden.

Dieser Anwendungsfall ist ganz anders, da Sie normalerweise den Quellcode verwenden und OpenAI die API-Dokumentation generieren lassen würden. Stattdessen verwendet dieses interne Paket in Remotion die OpenAI-API, um JSDoc-Kommentare für eine Funktion unter Verwendung der API-Dokumentation und des Quellcodes zu generieren.

Wir werden uns auf hoher Ebene ansehen, wie dieses Paket konfiguriert ist:

1. improve-docs.ts
2. jsdoc generieren

Dokumente verbessern

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 verfügt über die oben genannten Importe. generiertJSDocTask wird aus dem Ordner „Aufgaben“ importiert.

Je nach Aufgabe können Sie entweder ein JSDoc erstellen oder Fehler finden.

Generieren Sie JSDoc

generate-jsdoc.ts verwendet die OpenAI-API und verfügt über Eingabeaufforderungen, wie im obigen Bild gezeigt.

Bitte beachten Sie, dass dadurch nur das generierte JSDoc in die Konsole geschrieben wird. Wäre es möglich, diese JSDoc-Kommentare programmgesteuert in die Datei zu schreiben? Ich bin mir nicht sicher, aber es lohnt sich, die AST-Dokumentation zu lesen, um zu sehen, ob eine API verfügbar ist, um JSDoc-Kommentare direkt über dem Funktions- oder Klassennamen hinzuzufügen. Es ist bekannt, dass ts-morph in shadcn-ui/ui verwendet wird, um den Quellcode auf AST-Ebene zu manipulieren.

Über uns:

Website: https://thinkthroo.com/

Github: https://github.com/thinkthroo/thinkthroo (Geben Sie uns einen Stern!)

Erstellen Sie kostenlos Open-Source-Projekte von Grund auf

Verbessern Sie die Programmierfähigkeiten Ihres Teams.

Benötigen Sie Hilfe bei einem Projekt? Kontaktieren Sie uns unter thinkthroo@gmail.com

Referenzen:

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

Das obige ist der detaillierte Inhalt vonGenerieren eines JSDoc-Kommentars für Ihre Funktion mit OpenAI.. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!