JSDoc è nu putenti giniraturi di ducumintazzioni pi JavaScript. Usa cummenti furmati apposta pi criari na ducumintazzioni API dittagghiata pû vostru còdici. Aggiungennu cummenti JSDoc ê file JavaScript, po dari nfurmazzioni chiari e strutturati ncapu li funziuna, li classi e li moduli.
Carattirìstichi chiavi di JSDoc:
Tipu nfurmazzioni
Paràmitri dâ funzioni e valura di riturnu
Discrizzioni di classi e mètudi
Ducumintazzioni dû mòdulu
Nu tag assai utili nna JSDoc è lu tag @example. Stu tag ti cunzenti di nchiùjiri esempi di còdici nnâ tò ducumintazzioni. Ciò ca distingui lu nostru strumentu è la so capacità di prisirvari la furmatazzioni, l'indenzioni e li ntirruzzioni di righi nnô tag @example. Chistu signìfica ca si ponnu scriviri esempi di còdici cchiù liggìbbili e rialìstici, accussì è cchiù fàcili pî sviluppatura capiri comu usari li funziuna o li classi.
Esempiu d'usu:
/**
* 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;
}
Usannu lu nostru giniraturi di cummenti JSDoc online, si po criari facilmenti na ducumintazzioni furmatata bona ca nchiudi na furmatazzioni prisirvata nnî vostri esempi di còdici, facennu la vostra ducumintazzioni JavaScript cchiù chiara ed efficaci.