JSDoc waa dhaliye dukumeenti awood leh JavaScript. Waxay isticmaashaa faallooyin si gaar ah loo habeeyey si ay u abuurto dukumeenti API oo faahfaahsan koodkaaga. Markaad ku darto faallooyinka JSDoc faylalkaaga JavaScript, waxaad bixin kartaa macluumaad cad oo habaysan oo ku saabsan shaqooyinkaaga, fasallada, iyo qaybahaaga.
Tilmaamaha muhiimka ah ee JSDoc:
Nooca macluumaadka
Halbeegyada shaqada iyo soo celinta qiyamka
Tilmaamaha fasalka iyo habka
Dukumeentiga moduleka
Mid ka mid ah summada si gaar ah waxtar u leh ee JSDoc waa @tusaale tag. Summadan waxay kuu oggolaanaysaa inaad ku darto tusaalayaal kood dukumeentigaaga. Waxa qalabkeena ka soocaya waa awooda ay u leedahay in ay ilaaliso qaabaynta, gelida, iyo xariiqda jebinta gudaha sumadda @tusaale. Tani waxay ka dhigan tahay inaad qori karto tusaalooyin kood la akhrin karo oo macquul ah, taasoo u sahlaysa horumariyeyaasha inay fahmaan sida loo isticmaalo hawlahaaga ama fasalladaada.
Tusaale ahaan isticmaalka:
/**
* 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;
}
Adigoo isticmaalaya koronto dhaliyaha faallooyinka JSDoc, waxaad si fudud u abuuri kartaa dukumeenti si wanaagsan loo qaabeeyey oo ay ku jiraan habaynta la xafiday ee tusaalaha koodkaaga, taasoo ka dhigaysa dukumeentigaaga JavaScript mid cad oo waxtar leh.