JSDoc és un potent generador de documentació per a JavaScript. Utilitza comentaris amb un format especial per crear documentació detallada de l'API per al vostre codi. Si afegiu comentaris JSDoc als vostres fitxers JavaScript, podeu proporcionar informació clara i estructurada sobre les vostres funcions, classes i mòduls.
Característiques principals de JSDoc:
Informació de tipus
Paràmetres de funció i valors de retorn
Descripcions de classes i mètodes
Documentació del mòdul
Una etiqueta especialment útil a JSDoc és l'etiqueta @example. Aquesta etiqueta us permet incloure exemples de codi a la vostra documentació. El que diferencia la nostra eina és la seva capacitat de conservar el format, el sagnat i els salts de línia dins de l'etiqueta @example. Això vol dir que podeu escriure exemples de codi més llegibles i realistes, cosa que facilita als desenvolupadors com utilitzar les vostres funcions o classes.
Exemple d'ús:
/**
* 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;
}
Mitjançant l'ús del nostre generador de comentaris JSDoc en línia, podeu crear fàcilment documentació ben formatada que inclogui el format conservat als vostres exemples de codi, fent que la documentació de JavaScript sigui més clara i eficaç.