JSDoc

JSDoc  je generátor HTML dokumentace z komentářů ke zdrojovému kódu JavaScriptu . Syntaxe JSDoc je podobná syntaxi Javadoc , která se používá k dokumentaci kódu Java, ale je navržena pro práci s jazykem JavaScript, který je dynamičtější, a proto JSDoc není kompatibilní s Javadoc. Stejně jako Javadoc, JSDoc umožňuje programátorovi vytvářet doclety a značky, které mohou být výstupem do souboru, jako je HTML nebo RTF.

JSDoc tagy

Přestože tento seznam není vyčerpávající, aktivně se používají následující značky.

Štítek Popis
@autor Jméno vývojáře
@konstruktor Označí funkci jako konstruktor
@zastaralé Označí metodu jako zastaralou a zastaralou
@výjimka Synonymum pro @throws
@param Popisuje argument funkce; můžete určit typ zadáním ve složených závorkách
@soukromá Znamená to, že metoda je soukromá
@vrátit se Popisuje návratovou hodnotu
@vrací se Synonymum pro návrat
@vidět Popisuje vztah s jiným objektem
@tento Určuje typ objektu, na který ukazuje klíčové slovo "this" uvnitř funkce.
@hodí Popisuje výjimky vyvolané metodou
@verze Verze knihovny

Příklad

Příklad použití JSDoc.

třídní kruh { /** * Vytvoří instanci Circle. * * @konstruktor * @this{Circle} * @param {číslo} r - Poloměr kružnice. */ konstruktor ( r ) { /** @soukromá */ toto . poloměr = r ; /** @soukromá */ toto . obvod = 2 * Matematika . PI * r ; } /** * Vypočítá obvod * * @zastaralé * @this{Circle} * @return {číslo} obvod. */ vypočítatObvod () { návrat 2 * Matematika . PI * toto . poloměr ; } /** * Vrátí předem vypočítaný obvod. * * @this{Circle} * @return {číslo} obvod. */ getCircumference () { vrátit toto . obvod ; } /** * Řetězcová reprezentace objektu Circle. * * @override * @this{Circle} * @return {string} Informace o objektu Circle. */ toString () { return "Objekt Circle s poloměrem " + this . poloměr + "." ; } /** * Vytvoří novou instanci kruhu podle průměru. * * @param {číslo} d - Průměr kruhu. * @return {Circle} Nový objekt kruhu. * *@statický */ statický od průměru ( d ) { vrátit nový kruh ( d / 2 ); } }

Historie

První použití komentářů ve stylu Javadoc k dokumentování kódu JavaScript pochází z roku 1999 az projektu Netscape/Mozilla Rhino .

Použití JSDoc

Viz také

Poznámky

Odkazy

Generátory dokumentů