Menjana ulasan JSDoc untuk fungsi anda menggunakan OpenAI.

Artikel ini diinspirasikan daripada pakej dalaman Remotion, ai-improvements. Pakej dalaman ini digunakan untuk menambah baik/menjana ulasan JSDoc dan log masuk ke konsol untuk fungsi dalam kod sumber Remotion.

Kes penggunaan ini agak berbeza kerana anda biasanya menggunakan kod sumber dan membiarkan OpenAI menjana dokumentasi API tetapi sebaliknya dalam Remotion, pakej dalaman ini menggunakan API OpenAI untuk menjana ulasan JSDoc untuk fungsi menggunakan dokumentasi API dan kod sumber.

Kami akan melihat pada tahap tinggi bagaimana pakej ini dikonfigurasikan:

1. improve-docs.ts
2. jana-jsdoc

Perbaiki dokumen

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 mempunyai import di atas. generateJSDocTask diimport daripada folder 'tugas'.

bergantung pada tugasan, anda boleh menjana JSDoc atau mencari kesilapan.

Hasilkan JSDoc

generate-jsdoc.ts menggunakan API openai dan mempunyai gesaan seperti yang ditunjukkan dalam imej di atas.

Sila ambil perhatian bahawa ini hanya akan menulis JSDoc yang dijana pada konsol. Adakah mungkin untuk menulis ulasan JSDoc ini secara terprogram dalam fail? Tidak pasti, tetapi perlu membaca dokumentasi AST untuk melihat sama ada terdapat sebarang API tersedia untuk menambah ulasan JSDoc tepat di atas fungsi atau nama kelas. ts-morph diketahui digunakan dalam shadcn-ui/ui untuk memanipulasi kod sumber pada tahap AST.

Tentang kami:

tapak web: https://thinkthroo.com/

Github: https://github.com/thinkthroo/thinkthroo (Beri kami bintang!)

Bina projek sumber terbuka dari awal secara percuma

Tingkatkan kemahiran pengekodan pasukan anda.

Perlukan bantuan dengan projek? Hubungi kami di thinkthroo@gmail.com

Rujukan:

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

Atas ialah kandungan terperinci Menjana ulasan JSDoc untuk fungsi anda menggunakan OpenAI.. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!