JSDoc

JSDoc kan producera dokumentation i ett stort antal textbaserade format som HTML, XML, JSON, och så vidare.

JSDoc tidigare känt som JsDoc Toolkit.

Den tidigare JSDoc versionerna används Java för att tolka källkoden, extrahera kommentarer och generera dokumentationen. Eftersom 3.x grenen Node.js används istället.

Förutom Node.js, JSDoc kan också arbeta med Mozillas Rhino motor också.

Om du vill använda JSDoc ordentligt, kontrollera dess dokumentation för information om hur du formaterar din källkod kommentarer så att de kan detekteras och användas av JSDoc motor.

Vad är nytt i den här versionen.

• Kan nu köra JSDoc på Node.js
• kan nu användainterface ochimplements taggar för att dokumentera gränssnitt och deras implementationer.
• Stängning Compiler sinheritDoc ochoverride taggar stöds nu.
• Om JSDoc kommentar till en symbol omfattarmixes tag, alla mixins visas nu i symbolen dokumentation.
• JSDoc kan nu logga information till konsolen som det körs (till exempel namnet på varje fil som JSDoc tolkar). För att logga denna information, köra JSDoc med --verbose flaggan.
• Kan nu använda alla filer som förpackningen eller README-filen för din dokumentation. Använd -P / - paketet / och -R / -. Readme flaggorna för att ange paketet och README fil
• Standardmallen är typografi och färgsättning har förbättrats avsevärt.

Vad är nytt i version 3.3.2:

• Kan nu köra JSDoc på Node.js.
• kan nu användainterface ochimplements taggar för att dokumentera gränssnitt och deras implementationer.
• Stängning Compiler sinheritDoc ochoverride taggar stöds nu.
• Om JSDoc kommentar till en symbol omfattarmixes tag, alla mixins visas nu i symbolen dokumentation.
• JSDoc kan nu logga information till konsolen som det körs (till exempel namnet på varje fil som JSDoc tolkar). För att logga denna information, köra JSDoc med --verbose flaggan.
• Kan nu använda alla filer som förpackningen eller README-filen för din dokumentation. Använd -P / - paketet / och -R / -. Readme flaggorna för att ange paketet och README fil
• Standardmallen är typografi och färgsättning har förbättrats avsevärt.

Vad är nytt i version 3.3.0:

• Kan nu köra JSDoc på Node.js.
• kan nu användainterface ochimplements taggar för att dokumentera gränssnitt och deras implementationer.
• Stängning Compiler sinheritDoc ochoverride taggar stöds nu.
• Om JSDoc kommentar till en symbol omfattarmixes tag, alla mixins visas nu i symbolen dokumentation.
• JSDoc kan nu logga information till konsolen som det körs (till exempel namnet på varje fil som JSDoc tolkar). För att logga denna information, köra JSDoc med --verbose flaggan.
• Kan nu använda alla filer som förpackningen eller README-filen för din dokumentation. Använd -P / - paketet / och -R / -. Readme flaggorna för att ange paketet och README fil
• Standardmallen är typografi och färgsättning har förbättrats avsevärt.

Vad är nytt i version 3.2.2 / 3.3.0-beta1:

• Adresserad en tillbakagång i JSDoc 3.2.1 som kan förhindra en funktion intyg från skuggning en deklaration med samma namn i en yttre ramen.
• Om ett barn klass åsidosätter en metod i en överordnad klass utan att dokumentera åsido metoden, metodens dokumentationen nu kopieras från den överordnade klassen.
• Du kan nu använda inline HTML-taggar i Wiki-formaterad text. Dessutom använder JSDoc nu bara den markerade Wiki parser; den markdown-js parser har avlägsnats.
• Typ uttryck kan nu inkludera ett mycket bredare spektrum av repeterbara slag. Dessutom kan du nu använda Stängning Compiler s nullable och icke-nullable modifierings med repeterbara slag. Till exempel är den typ uttryck ...! Sträng (en repeterbar, icke innehålla null sträng) nu analyseras korrekt.

Vad är nytt i version 2.4.0:

• Fixat bugg som lagt mutiple symboler med samma namn till docs.
• Utökat stöd för alternativet -m för att undertrycka varningar för flera docs.
• Inkom lapp med brownsea42 att stödja noterade användarvariabler på kommandoraden.
• Fixat bugg som ibland orsakade länkar till händelser vara felaktig.

Krav :

• Javascript aktiverat på klientsidan
• Node.js 0,10 eller högre