JSDoc ialah penjana dokumentasi yang berkuasa untuk JavaScript. Ia menggunakan komen berformat khas untuk membuat dokumentasi API terperinci untuk kod anda. Dengan menambahkan ulasan JSDoc pada fail JavaScript anda, anda boleh memberikan maklumat yang jelas dan berstruktur tentang fungsi, kelas dan modul anda.
Ciri utama JSDoc:
Taip maklumat
Parameter fungsi dan nilai pulangan
Penerangan kelas dan kaedah
Dokumentasi modul
Satu teg yang amat berguna dalam JSDoc ialah teg @example. Teg ini membolehkan anda memasukkan contoh kod dalam dokumentasi anda. Apa yang membezakan alat kami ialah keupayaannya untuk mengekalkan pemformatan, lekukan dan pemisah baris dalam teg @example. Ini bermakna anda boleh menulis lebih banyak contoh kod yang boleh dibaca dan realistik, menjadikannya lebih mudah untuk pembangun memahami cara menggunakan fungsi atau kelas anda.
Contoh penggunaan:
/**
* Calculates the sum of two numbers.
* @param {number} a - The first number.
* @param {number} b - The second number.
* @returns {number} The sum of a and b.
* @example
* // This example preserves formatting and line breaks
* const result = add(5, 3);
* console.log(result);
* // Output: 8
*/
function add(a, b) {
return a + b;
}
Dengan menggunakan penjana ulasan JSDoc dalam talian kami, anda boleh membuat dokumentasi berformat baik dengan mudah termasuk pemformatan yang dipelihara dalam contoh kod anda, menjadikan dokumentasi JavaScript anda lebih jelas dan berkesan.