JSDoc je výkonný generátor dokumentace pro JavaScript. Používá speciálně formátované komentáře k vytvoření podrobné dokumentace API pro váš kód. Přidáním komentářů JSDoc do souborů JavaScriptu můžete poskytnout jasné a strukturované informace o svých funkcích, třídách a modulech.
Klíčové vlastnosti JSDoc:
Zadejte informace
Parametry funkcí a návratové hodnoty
Popisy tříd a metod
Dokumentace modulu
Jedna obzvláště užitečná značka v JSDoc je značka @example. Tato značka vám umožňuje zahrnout příklady kódu do vaší dokumentace. To, co odlišuje náš nástroj, je jeho schopnost zachovat formátování, odsazení a zalomení řádků ve značce @example. To znamená, že můžete psát čitelnější a realističtější příklady kódu, což vývojářům usnadní pochopit, jak používat vaše funkce nebo třídy.
Příklad použití:
/**
* 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;
}
Pomocí našeho online generátoru komentářů JSDoc můžete snadno vytvořit dobře naformátovanou dokumentaci, která zahrnuje zachované formátování v příkladech kódu, díky čemuž bude vaše dokumentace JavaScriptu přehlednější a efektivnější.