JSDoc se yon dèlko dokiman pwisan pou JavaScript. Li itilize kòmantè espesyal fòma pou kreye dokiman API detaye pou kòd ou a. Lè w ajoute kòmantè JSDoc nan fichye JavaScript ou yo, ou ka bay enfòmasyon klè ak estriktire sou fonksyon ou, klas, ak modil ou.
Karakteristik kle nan JSDoc:
Tape enfòmasyon
Paramèt fonksyon ak valè retounen
Klas ak deskripsyon metòd
Modil dokiman
Yon tag patikilyèman itil nan JSDoc se tag @egzanp. Tag sa a pèmèt ou mete egzanp kòd nan dokiman ou. Ki sa ki mete zouti nou an apa se kapasite li pou konsève fòma, endentasyon, ak kase liy nan tag @egzanp la. Sa vle di ou ka ekri egzanp kòd ki pi lizib ak reyalis, sa ki fè li pi fasil pou devlopè yo konprann ki jan yo sèvi ak fonksyon ou oswa klas yo.
Egzanp itilizasyon:
/**
* 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;
}
Lè w itilize dèlko kòmantè JSDoc nou an sou entènèt, ou ka fasilman kreye dokiman ki byen fòma ki gen ladan fòma konsève nan egzanp kòd ou yo, ki fè dokiman JavaScript ou pi klè ak efikas.