JSDoc

A JSDoc  egy HTML - dokumentáció generátor a JavaScript forráskód megjegyzéseiből . A JSDoc szintaxis hasonló a Javadoc szintaxishoz , amelyet a Java kód dokumentálására használnak, de úgy tervezték, hogy együttműködjön a JavaScript nyelvvel, amely dinamikusabb, és ezért a JSDoc nem kompatibilis a Javadoc nyelvvel. A Javadoc-hoz hasonlóan a JSDoc is lehetővé teszi a programozó számára, hogy docleteket és címkéket hozzon létre, amelyek egy fájlba (például HTML vagy RTF) kiadhatók.

JSDoc címkék

Bár ez a lista nem teljes, a következő címkék aktívak.

Címke Leírás
@szerző Fejlesztő neve
@konstruktőr Egy függvényt konstruktorként jelöl meg
@elavult Megjelöl egy módszert elavultként és elavultként
@kivétel A @dobások szinonimája
@param Leír egy függvény argumentumot; kapcsos zárójelben megadva megadhatja a típust
@magán Azt jelenti, hogy a módszer privát
@Visszatérés Leírja a visszatérési értéket
@visszatér A visszatérés szinonimája
@lát Egy másik tárggyal való kapcsolatot ír le
@ez Megadja annak az objektumnak a típusát, amelyre a függvényen belül a "this" kulcsszó mutat.
@dobok Leírja a módszer által kiváltott kivételeket
@változat Könyvtári verzió

Példa

Példa a JSDoc használatára.

osztály kör { /** * Kör példányt hoz létre. * * @konstruktor * @this{Circle} * @param {szám} r - A kör sugara. */ konstruktor ( r ) { /** @magán */ ezt . sugár = r ; /** @magán */ ezt . kerület = 2 * Math . PI * r ; } /** * Kiszámítja a kerületet * * @elavult * @this{Circle} * @return {szám} Kerület. */ kalkulálKerület () { return 2 * Matek . PI * ez . sugár ; } /** * Az előre kiszámított kerületet adja vissza. * * @this{Circle} * @return {szám} Kerület. */ getCircumference () { ezt visszaküldeni . kerülete ; } /** * Egy Circle objektum karakterlánc reprezentációja. * * @override * @this{Circle} * @return {karakterlánc} Információk a Circle objektumról. */ toString () { return "A kör objektum sugara" + ez . sugár + "." ; } /** * Új körpéldányt hoz létre átmérő alapján. * * @param {szám} d - A kör átmérője. * @return {Circle} Új kör objektum. * *@statikus */ static from Diameter ( d ) { új kör visszaadása ( d / 2 ); } }

Történelem

A Javadoc-stílusú megjegyzések legkorábbi használata JavaScript-kód dokumentálására 1999-ből és a Netscape/Mozilla Rhino projektből származik .

A JSDoc használata

  • A Google Closure Linter és Closure Compiler [1]
  • A JSDoc szintaxis leírása az Apress Foundations of Ajax ISBN 1-59059-582-3 számában történt .
  • A Visual Studio , az IntelliJ IDEA , a PhpStorm , a WebStorm és a RubyMine értik a JSDoc szintaxist.
  • Vannak beépülő modulok az Eclipse IDE -hez , amelyek megvalósítják a JSDoc szintaxist. Az Eclipse-alapú szerkesztő, az Aptana Studio támogatja a ScriptDoc-ot, és tartalmaz néhány, a ScriptDoc-ban kommentált JavaScript-fájlt.
  • Mozile archiválva 2018. október 6-án a Wayback Machine -en , a Mozilla Inline Editor JSDoc-t használ.

Lásd még

Jegyzetek

Linkek

Dokumentumgenerátorok