JSDoc

JSDoc voi tuottaa asiakirjoja useilla tekstipohjaisia ​​tiedostomuotoja, kuten HTML, XML, JSON, ja niin edelleen.

JSDoc aiemmin tiedä kuin JsDoc Toolkit.

Entinen JSDoc versiot käytetään Java jäsentää lähdekoodin, poimia kommentit ja tuottaa asiakirjoja. Koska 3.x haara Node.js sijaan käytetään.

Lisäksi Node.js, JSDoc voivat myös työskennellä Mozillan Rhino moottori samoin.

Jos haluat käyttää JSDoc oikein, tarkista sen ohjeista tietoja siitä, miten muotoilla lähdekoodia kommentteja, jotta ne voidaan havaita ja käyttää JSDoc moottorin.

Mikä on uusi tässä julkaisussa:

• Voi nyt ajaa JSDoc päälle Node.js.
• voivat nyt käyttääinterface jaimplements tunnisteet dokumentoida rajapinnat ja niiden toteutukset.
• päättäminen kääntäjäninheritDoc jaoverride tunnisteet tuetaan nyt.
• Jos JSDoc kommentin symboli sisältäämixes tag, kaikki mixins nyt näkyvät symbolin asiakirjat.
• JSDoc voi kirjautua tiedot konsoliin koska se kulkee (esim kunkin tiedoston nimi, joka JSDoc jäsentää). Kirjautua näitä tietoja, suorita JSDoc kanssa --verbose lippu.
• Voi nyt käyttää mitä tahansa tiedoston pakkaus tai LUEMINUT tiedosto asiakirjat. Käytä P / - paketti / ja R / - lueminut liput täsmentää paketin ja README-tiedosto.
• Oletusmalli n typografia ja värimaailma ovat parantuneet merkittävästi.

Mikä on uusi versiossa 3.3.2:

• Voi nyt ajaa JSDoc päälle Node.js.
• voivat nyt käyttääinterface jaimplements tunnisteet dokumentoida rajapinnat ja niiden toteutukset.
• päättäminen kääntäjäninheritDoc jaoverride tunnisteet tuetaan nyt.
• Jos JSDoc kommentin symboli sisältäämixes tag, kaikki mixins nyt näkyvät symbolin asiakirjat.
• JSDoc voi kirjautua tiedot konsoliin koska se kulkee (esim kunkin tiedoston nimi, joka JSDoc jäsentää). Kirjautua näitä tietoja, suorita JSDoc kanssa --verbose lippu.
• Voi nyt käyttää mitä tahansa tiedoston pakkaus tai LUEMINUT tiedosto asiakirjat. Käytä P / - paketti / ja R / - lueminut liput täsmentää paketin ja README-tiedosto.
• Oletusmalli n typografia ja värimaailma ovat parantuneet merkittävästi.

Mikä on uusi versiossa 3.3.0:

• Voi nyt ajaa JSDoc päälle Node.js.
• voivat nyt käyttääinterface jaimplements tunnisteet dokumentoida rajapinnat ja niiden toteutukset.
• päättäminen kääntäjäninheritDoc jaoverride tunnisteet tuetaan nyt.
• Jos JSDoc kommentin symboli sisältäämixes tag, kaikki mixins nyt näkyvät symbolin asiakirjat.
• JSDoc voi kirjautua tiedot konsoliin koska se kulkee (esim kunkin tiedoston nimi, joka JSDoc jäsentää). Kirjautua näitä tietoja, suorita JSDoc kanssa --verbose lippu.
• Voi nyt käyttää mitä tahansa tiedoston pakkaus tai LUEMINUT tiedosto asiakirjat. Käytä P / - paketti / ja R / - lueminut liput täsmentää paketin ja README-tiedosto.
• Oletusmalli n typografia ja värimaailma ovat parantuneet merkittävästi.

Mikä on uusi versio 3.2.2 / 3.3.0-beta1:

• Osoitteellinen taantumisen JSDoc 3.2.1, joka voisi estää toiminto vakuutus varjostavat julistuksen samanniminen ulompi soveltamisalaan.
• Jos lapsi luokka ohittaa menetelmä vanhemman luokan ilman dokumentointia yliohjatut menetelmä, menetelmä ohjeista on nyt kopioitu vanhemman luokan.
• Voit nyt käyttää inline HTML-tagit Wikitekstin-muotoiltua tekstiä. Lisäksi JSDoc käyttää nyt vain valitut Wikitekstin jäsennin; markdown-js jäsennin on poistettu.
• Tyyppi ilmaukset voivat nyt myös paljon laajempaa toistettavissa tyyppejä. Lisäksi voit nyt käyttää päättäminen kääntäjän nullable ja ei-nullable määritteet toistettavia tyyppejä. Esimerkiksi tyypin ilme ...! Merkkijono (toistettavissa, ei-nullable string) on ​​nyt jäsennetään oikein.

Mikä on uusi versiossa 2.4.0:

• Kiinteä vika, että lisätty mutiple symbolit samanniminen Dokumentteihin.
• Lisätty tuki -m tukahduttaa varoitukset useita docs.
• Lisätty laastarista brownsea42 tukea noteerattu käyttäjän muuttujat komentorivillä.
• Kiinteä vika, että joskus aiheuttanut linkkejä tapahtumia virheelliseksi.

vaatimukset :

• Javascriptin asiakkaan puolella
• Node.js 0,10 tai suurempi