JSDoc ko ƴellitoowo binndanɗe doole ngam JavaScript. Ina huutoroo miijooji baɗaaɗi keertiiɗi ngam sosde binndanɗe API laaɓtuɗe wonande kod maa. So a ɓeydii miijooji JSDoc e piille maa JavaScript, aɗa waawi rokkude kabaruuji laaɓtuɗi e njuɓɓudi ko fayti e golle maa, kalaasuuji maa, e moodeluuji maa.
Ko ɓuri teeŋtude e geɗe JSDoc:
Winndu kabaruuji
Parametruuji gollal e nafooje ngartam
Sifaaaji kilaas e laabi
Dokimaaji moodel
Tag gooto teeŋtuɗo nafoore e nder JSDoc ko tag @example. Oo tag ina addana-ma waɗde yeruuji kod e nder binndanɗe maa. Ko seerndi kuutorgal amen ko mbaawka mum hisnude mbaydi, jokkorgal, e jokkorgal diidi nder tag @example. Ɗum firti ko aɗa waawi winndude yeruuji kod ɓurɗi janngeede e goonga, tawa ina weeɓina ƴellitooɓe faamde no kuutorto-ɗaa golle maa walla kalaasuuji maa.
Yeru kuutoragol:
/**
* 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;
}
So a huutoriima lowre men JSDoc commentaire, aɗa waawi sosde binndanɗe moƴƴe tawa ina waɗi binndanɗe desorɗe e nder yeruuji kod maa, tawa aɗa waɗa binndanɗe maa JavaScript ɓurɗe laaɓtude e moƴƴude.