JSDoc

JSDoc gali pateikti dokumentus plataus skaičius tekstinių formatų, pavyzdžiui, HTML, XML, JSON, ir pan.

JSDoc anksčiau buvo žinoma kaip JsDoc Toolkit.

Buvę JSDoc versijos naudojamos Java išanalizuoti kodą, ekstraktas pastabas ir generuoti dokumentaciją. Nuo 3.x filialo Node.js yra naudojamas vietoj.

Be Node.js, JSDoc taip pat gali dirbti su Mozilla Rhino variklis taip pat.

Jei tinkamai naudoti JSDoc, patikrinti jo dokumentus dėl informacijos apie tai, kaip formatuoti savo šaltinio kodą komentarų, todėl jie gali būti aptinkami ir naudojami JSDoc variklį.

Kas naujo , šioje laidoje.

• dabar gali paleisti JSDoc ant Node.js
• dabar galite naudotiinterface irimplements žymes dokumentuoti sąsajas ir jų vykdymas.
• uždarymo sudarytojas anketainheritDoc iroverride žodžius, kurie dabar palaiko.
• Jei JSDoc komentaras simbolis apimamixes žymeles, visi mixins dabar rodomas simbolis dokumentaciją.
• JSDoc dabar gali prisijungti informaciją konsolės, kaip ji veikia (pavyzdžiui, kiekvieno failo, kad, analizuojant JSDoc pavadinimas). Norėdami prisijungti šią informaciją, paleisti JSDoc su verbose vėliava.
• Ar dabar naudoja bet kokį failą, kaip ant pakuotės ar README faile jūsų dokumentus. Naudokite -P / - paketą ir / -R / -. Readme vėliavas nurodyti pakuotės ir README failą
• numatytąjį šabloną anketa spausdinimas ir spalvų schemą buvo žymiai pagerėjo.

Kas naujo versijos 3.3.2:

• dabar gali paleisti JSDoc ant Node.js.
• dabar galite naudotiinterface irimplements žymes dokumentuoti sąsajas ir jų vykdymas.
• uždarymo sudarytojas anketainheritDoc iroverride žodžius, kurie dabar palaiko.
• Jei JSDoc komentaras simbolis apimamixes žymeles, visi mixins dabar rodomas simbolis dokumentaciją.
• JSDoc dabar gali prisijungti informaciją konsolės, kaip ji veikia (pavyzdžiui, kiekvieno failo, kad, analizuojant JSDoc pavadinimas). Norėdami prisijungti šią informaciją, paleisti JSDoc su verbose vėliava.
• Ar dabar naudoja bet kokį failą, kaip ant pakuotės ar README faile jūsų dokumentus. Naudokite -P / - paketą ir / -R / -. Readme vėliavas nurodyti pakuotės ir README failą
• numatytąjį šabloną anketa spausdinimas ir spalvų schemą buvo žymiai pagerėjo.

Kas naujo versijos 3.3.0:

• dabar gali paleisti JSDoc ant Node.js.
• dabar galite naudotiinterface irimplements žymes dokumentuoti sąsajas ir jų vykdymas.
• uždarymo sudarytojas anketainheritDoc iroverride žodžius, kurie dabar palaiko.
• Jei JSDoc komentaras simbolis apimamixes žymeles, visi mixins dabar rodomas simbolis dokumentaciją.
• JSDoc dabar gali prisijungti informaciją konsolės, kaip ji veikia (pavyzdžiui, kiekvieno failo, kad, analizuojant JSDoc pavadinimas). Norėdami prisijungti šią informaciją, paleisti JSDoc su verbose vėliava.
• Ar dabar naudoja bet kokį failą, kaip ant pakuotės ar README faile jūsų dokumentus. Naudokite -P / - paketą ir / -R / -. Readme vėliavas nurodyti pakuotės ir README failą
• numatytąjį šabloną anketa spausdinimas ir spalvų schemą buvo žymiai pagerėjo.

Kas naujo versiją 3.2.2 / 3.3.0-beta1:

• kreipėsi regresiją JSDoc 3.2.1, kad galėtų užkirsti kelią funkciją deklaraciją, šešėliai deklaraciją su to paties pavadinimo išorinio taikymo sritį.
• Jei vaikas klasė viršesnis A patronuojančios klasės metodas be dokumentavimo svarbesni, būdas dokumentacija dabar nukopijuoti iš patronuojančios klasės.
• Dabar galite naudoti inline HTML žymes reklamos kainos "formato tekstą. Be to, JSDoc dabar naudoja tik pažymėtą markdown analizatorius; markdown-JS analizatorius buvo ištrintas.
• tipas išraiškos dabar gali apimti daug platesnį pasikartojantis tipų. Be to, dabar galite naudoti uždarymo sudarytojas anketa nullable ir nenuliniame modifikatorius su pasikartojantis tipų. Pavyzdžiui, tipo išraiška ...! Eilutė (A pakartoti, nenuliniame eilutė) dabar apdoroti teisingai.

Kas naujo versijos 2.4.0:

• Ištaisyta klaida, kad pridėta mutiple simbolius su tuo pačiu pavadinimu į dokumentus.
• Pridėta paramą -m galimybe slopinti įspėjimai keliais docs.
• Pridėta pleistras iki brownsea42 remti kotiruojamas vartotojo kintamieji komandinėje eilutėje.
• Ištaisyta klaida, kad kartais sukelia nuorodas į renginius, kad būtų neteisinga.

Reikalavimai :

• veikiancio Javascript kliento pusėje;
• Node.js 0,10 arba didesnis;