JSDoc nigikoresho gikomeye cyerekana generator ya JavaScript. Ikoresha ibitekerezo byihariye kugirango ikore ibisobanuro birambuye bya API kuri code yawe. Wongeyeho ibisobanuro bya JSDoc muri dosiye yawe ya JavaScript, urashobora gutanga amakuru asobanutse kandi yubatswe kubyerekeye imikorere yawe, amasomo, hamwe na module.
Ibyingenzi byingenzi bya JSDoc:
Andika amakuru
Imikorere ibipimo no gusubiza indangagaciro
Icyiciro nuburyo bwo gusobanura
Inyandiko
Ikimenyetso cyingirakamaro cyane muri JSDoc ni @urugero. Akarango kagufasha gushyiramo kode ingero mubyangombwa byawe. Ikitandukanya igikoresho cyacu nubushobozi bwacyo bwo kubika imiterere, indentation, numurongo ucamo muri tagi ya @urugero. Ibi bivuze ko ushobora kwandika izindi ngero zisomeka kandi zifatika, byorohereza abitezimbere kumva uburyo wakoresha imirimo yawe cyangwa amasomo.
Urugero rwo gukoresha:
/**
* 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;
}