JSDoc

JSDoc kan produsere dokumentasjon i et stort antall tekstbaserte formater som HTML, XML, JSON, og så videre.

JSDoc ble tidligere kjent som JsDoc Toolkit.

Den tidligere JSDoc versjoner brukes Java å analysere kildekoden, trekke ut kommentarer og generere dokumentasjon. Siden 3.x grenen Node.js brukes i stedet.

I tillegg Node.js, JSDoc kan også arbeide med Mozillas Rhino motor også.

For å bruke JSDoc riktig, sjekk dokumentasjonen for informasjon om hvordan du formaterer kildekode kommentarer slik at de kan oppdages og brukes av JSDoc motor.

Hva er nytt i denne utgaven.

• Kan nå kjøre JSDoc på Node.js
• Kan nå brukeinterface ogimplements koder for å dokumentere grensesnitt og deres implementasjoner.
• Closure Compiler erinheritDoc ogoverride koder støttes nå.
• Hvis JSDoc kommentar til et symbol inkluderermixes tag, alle de mixins nå vises i symbol dokumentasjon.
• JSDoc kan nå logge informasjon til konsollen som det går (for eksempel navnet på hver fil som JSDoc analyserer). For å logge denne informasjonen, kjøre JSDoc med --verbose flagget.
• Kan nå bruke hvilken som helst fil som pakken eller README-filen for dokumentasjonen. Bruk -P / - pakke / og -R / -. Readme flagg for å spesifisere pakken og README fil
• Standardmalen er typografi og fargevalget har blitt betydelig forbedret.

Hva er nytt i versjon 3.3.2:

• Kan nå kjøre JSDoc på node.js.
• Kan nå brukeinterface ogimplements koder for å dokumentere grensesnitt og deres implementasjoner.
• Closure Compiler erinheritDoc ogoverride koder støttes nå.
• Hvis JSDoc kommentar til et symbol inkluderermixes tag, alle de mixins nå vises i symbol dokumentasjon.
• JSDoc kan nå logge informasjon til konsollen som det går (for eksempel navnet på hver fil som JSDoc analyserer). For å logge denne informasjonen, kjøre JSDoc med --verbose flagget.
• Kan nå bruke hvilken som helst fil som pakken eller README-filen for dokumentasjonen. Bruk -P / - pakke / og -R / -. Readme flagg for å spesifisere pakken og README fil
• Standardmalen er typografi og fargevalget har blitt betydelig forbedret.

Hva er nytt i versjon 3.3.0:

• Kan nå kjøre JSDoc på node.js.
• Kan nå brukeinterface ogimplements koder for å dokumentere grensesnitt og deres implementasjoner.
• Closure Compiler erinheritDoc ogoverride koder støttes nå.
• Hvis JSDoc kommentar til et symbol inkluderermixes tag, alle de mixins nå vises i symbol dokumentasjon.
• JSDoc kan nå logge informasjon til konsollen som det går (for eksempel navnet på hver fil som JSDoc analyserer). For å logge denne informasjonen, kjøre JSDoc med --verbose flagget.
• Kan nå bruke hvilken som helst fil som pakken eller README-filen for dokumentasjonen. Bruk -P / - pakke / og -R / -. Readme flagg for å spesifisere pakken og README fil
• Standardmalen er typografi og fargevalget har blitt betydelig forbedret.

Hva er nytt i versjon 3.2.2 / 3.3.0-beta1:

• Adressert en regresjon i JSDoc 3.2.1 som kan hindre en funksjon erklæring fra skygging en erklæring med samme navn i en ytre ramme.
• Hvis et barn klasse styrer en metode i en forelder klasse uten å dokumentere overstyres metoden, metoden dokumentasjon er nå kopiert fra den overordnede klassen.
• Du kan nå bruke inline HTML-koder i Markdown-formatert tekst. I tillegg bruker JSDoc nå bare den markerte Markdown parser; Markdown-js parser er fjernet.
• type uttrykk kan nå inkludere et mye bredere spekter av repeterbare typer. I tillegg kan du nå bruke Closure kompilatoren kan ha nullverdier og ikke-kan ha nullverdier modifiserings med repeterbare typer. For eksempel er den type uttrykk ...! String (en repeterbare, ikke-ha nullverdier streng) nå analyseres riktig.

Hva er nytt i versjon 2.4.0:

• Fast bug som tilsettes mutiple symboler med samme navn til docs.
• Lagt til støtte for den m alternativet å undertrykke advarsler for flere docs.
• Lagt patch ved brownsea42 å støtte sitert brukervariabler på kommandolinjen.
• Rettet feil som noen ganger forårsaket linker til hendelser å være feil.

Krav

• aktivere Javascript på klientsiden
• Node.js 0,10 eller høyere