JSDoc je výkonný generátor dokumentácie pre JavaScript. Používa špeciálne formátované komentáre na vytvorenie podrobnej dokumentácie API pre váš kód. Pridaním komentárov JSDoc do vašich súborov JavaScript môžete poskytnúť jasné a štruktúrované informácie o vašich funkciách, triedach a moduloch.
Kľúčové vlastnosti JSDoc:
Zadajte informácie
Parametre funkcie a návratové hodnoty
Opis tried a metód
Dokumentácia modulu
Jedna obzvlášť užitočná značka v JSDoc je značka @example. Táto značka vám umožňuje zahrnúť príklady kódu do vašej dokumentácie. To, čo odlišuje náš nástroj, je jeho schopnosť zachovať formátovanie, odsadenie a zlomy riadkov v rámci značky @example. To znamená, že môžete napísať čitateľnejšie a realistickejšie príklady kódu, vďaka čomu vývojári ľahšie pochopia, ako používať vaše funkcie alebo triedy.
Príklad použitia:
/**
* 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;
}
Pomocou nášho online generátora komentárov JSDoc môžete jednoducho vytvoriť dobre naformátovanú dokumentáciu, ktorá obsahuje zachované formátovanie v príkladoch kódu, vďaka čomu bude vaša dokumentácia JavaScript prehľadnejšia a efektívnejšia.