JSDoc

JSDoc in grado di produrre la documentazione in un ampio numero di formati di testo come HTML, XML, JSON, e così via.

JSDoc era conosciuto in precedenza come JsDoc Toolkit.

Le versioni precedenti JSDoc utilizzato Java per analizzare il codice sorgente, estrarre i commenti e generare la documentazione. Dal momento che il ramo 3.x Node.js viene usato al posto.

Inoltre Node.js, JSDoc può funzionare anche con il motore di Mozilla Rhino pure.

Per usare JSDoc correttamente, controllare la relativa documentazione per informazioni su come formattare i commenti del codice sorgente in modo che possano essere rilevati e utilizzati dal motore di JSDoc.

Cosa c'è di nuovo in questa versione:.

• Può ora gestita JSDoc su Node.js
• È ora possibile utilizzare i taginterface eimplements per documentare le interfacce e le loro implementazioni.
• inheritDoc eOverride tag di chiusura del compilatore sono ora supportati.
• Se il commento JSDoc per un simbolo include il tagmixes, tutti i mixin appaiono ora nella documentazione del simbolo.
• JSDoc possono ora registrare le informazioni alla console durante l'esecuzione (ad esempio, il nome di ogni file che JSDoc analizza). Per registrare queste informazioni, JSDoc correre con la bandiera --verbose.
• È ora possibile utilizzare qualsiasi file come pacchetto o del file README per la documentazione. Utilizzare i -P / - pacchetto / e / -R -. Bandiere readme per specificare il file del pacchetto e README
• tipografia e la combinazione di colori del modello predefinito sono state significativamente migliorate.

Cosa c'è di nuovo nella versione 3.3.2:

• Può ora gestita JSDoc su Node.js.
• È ora possibile utilizzare i taginterface eimplements per documentare le interfacce e le loro implementazioni.
• inheritDoc eOverride tag di chiusura del compilatore sono ora supportati.
• Se il commento JSDoc per un simbolo include il tagmixes, tutti i mixin appaiono ora nella documentazione del simbolo.
• JSDoc possono ora registrare le informazioni alla console durante l'esecuzione (ad esempio, il nome di ogni file che JSDoc analizza). Per registrare queste informazioni, JSDoc correre con la bandiera --verbose.
• È ora possibile utilizzare qualsiasi file come pacchetto o del file README per la documentazione. Utilizzare i -P / - pacchetto / e / -R -. Bandiere readme per specificare il file del pacchetto e README
• tipografia e la combinazione di colori del modello predefinito sono state significativamente migliorate.

Cosa c'è di nuovo nella versione 3.3.0:

• Può ora gestita JSDoc su Node.js.
• È ora possibile utilizzare i taginterface eimplements per documentare le interfacce e le loro implementazioni.
• inheritDoc eOverride tag di chiusura del compilatore sono ora supportati.
• Se il commento JSDoc per un simbolo include il tagmixes, tutti i mixin appaiono ora nella documentazione del simbolo.
• JSDoc possono ora registrare le informazioni alla console durante l'esecuzione (ad esempio, il nome di ogni file che JSDoc analizza). Per registrare queste informazioni, JSDoc correre con la bandiera --verbose.
• È ora possibile utilizzare qualsiasi file come pacchetto o del file README per la documentazione. Utilizzare i -P / - pacchetto / e / -R -. Bandiere readme per specificare il file del pacchetto e README
• tipografia e la combinazione di colori del modello predefinito sono state significativamente migliorate.

Cosa c'è di nuovo nella versione 3.2.2 / 3.3.0-beta1:

• Indirizzata una regressione JSDoc 3.2.1 che potrebbe impedire una dichiarazione di funzione da shadowing una dichiarazione con lo stesso nome in un ambito esterno.
• Se una classe figlia override un metodo in una classe genitore, senza documentare il metodo override, la documentazione del metodo è ora copiato dalla classe genitore.
• È ora possibile utilizzare i tag HTML in linea in testo formattato Markdown. Inoltre, JSDoc ora utilizza solo il parser Markdown marcata; il parser Markdown-js è stato rimosso.
• Tipo espressioni possono ora includere una gamma molto più ampia di tipi ripetibili. Inoltre, è ora possibile utilizzare modificatori annullabili e non annullabili di Chiusura del compilatore con i tipi ripetibili. Ad esempio, la stringa tipo di espressione ...! (A, stringa non annullabile ripetibile) è ora analizzato correttamente.

Cosa c'è di nuovo nella versione 2.4.0:

• Corretto il bug che ha aggiunto mutiple simboli con lo stesso nome docs.
• Aggiunto il supporto per l'opzione -m per sopprimere gli avvisi per più documenti.
• Aggiunto patch brownsea42 per sostenere variabili utente quotate sulla riga di comando.
• Corretto il bug che a volte ha causato i link agli eventi di essere corretto.

Requisiti :

• Javascript abilitato sul lato client
• Node.js 0.10 o superiore