JSDoc ni jenereta yenye nguvu ya hati kwa JavaScript. Inatumia maoni yaliyoumbizwa mahususi kuunda hati za kina za API za msimbo wako. Kwa kuongeza maoni ya JSDoc kwenye faili zako za JavaScript, unaweza kutoa maelezo wazi na yaliyopangwa kuhusu vipengele, madarasa na moduli zako.
Vipengele muhimu vya JSDoc:
Chapa habari
Vigezo vya kazi na maadili ya kurudi
Maelezo ya darasa na mbinu
Nyaraka za moduli
Lebo moja muhimu sana katika JSDoc ni lebo ya @example. Lebo hii inakuruhusu kujumuisha mifano ya msimbo katika hati zako. Kinachotofautisha chombo chetu ni uwezo wake wa kuhifadhi uumbizaji, ujongezaji na nafasi za kukatika mstari ndani ya lebo ya @example. Hii ina maana kwamba unaweza kuandika mifano ya msimbo inayosomeka zaidi na halisi, na kuifanya iwe rahisi kwa wasanidi programu kuelewa jinsi ya kutumia vipengele au madarasa yako.
Mfano wa matumizi:
/**
* 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;
}
Kwa kutumia jenereta yetu ya mtandaoni ya JSDoc ya maoni, unaweza kuunda hati zilizoumbizwa vyema ambazo zinajumuisha uumbizaji uliohifadhiwa katika mifano ya msimbo wako, na kufanya hati zako za JavaScript kuwa wazi na ufanisi zaidi.