JSDoc

Wys alles kan dokumentasie te produseer in 'n wye aantal teks-gebaseerde formate soos HTML, XML, into, en so aan.

Wys alles was voorheen bekend as Wys alles Toolkit.

Die voormalige Wys alles weergawes gebruik Java tot die bronkode ontleed, te onttrek kommentaar en genereer die dokumentasie. Sedert die 3.x tak Node.js plaas gebruik word.

Behalwe Node.js, Wys alles kan ook werk met Rhino enjin Mozilla se as well.

Om Wys alles behoorlik te gebruik, gaan sy dokumentasie vir meer inligting oor hoe om jou bronkode kommentaar formaat sodat hulle kan opgespoor word en gebruik word deur die enjin Wys alles se.

Wat is nuut in hierdie release:.

• Kan nou hardloop Wys alles op Node.js
• kan nou dieinterface enimplements tags interfaces en hul implementering te dokumenteer.
• Sluiting Compiler seinheritDoc enoverride tags word nou ondersteun.
• As die Wys alles kommentaar vir 'n simbool sluit diemixes tag, al die mixins nou in dokumentasie die simbool se.
• Wys alles kan nou inligting inteken op die console as dit loop (byvoorbeeld, die naam van elke lêer wat Wys alles ontleed). Om hierdie inligting, hardloop Wys alles met die --verbose vlag teken.
• Kan nou gebruik van enige lêer as die pakket of README lêer vir jou dokumentasie. Gebruik die P / - pakket / en -R / -. Readme vlae om die pakket en README lêer spesifiseer
• tipografie en kleurskema Die standaard sjabloon se is aansienlik verbeter.

Wat is nuut in die weergawe 3.3.2:

• Kan nou hardloop Wys alles op Node.js.
• kan nou dieinterface enimplements tags interfaces en hul implementering te dokumenteer.
• Sluiting Compiler seinheritDoc enoverride tags word nou ondersteun.
• As die Wys alles kommentaar vir 'n simbool sluit diemixes tag, al die mixins nou in dokumentasie die simbool se.
• Wys alles kan nou inligting inteken op die console as dit loop (byvoorbeeld, die naam van elke lêer wat Wys alles ontleed). Om hierdie inligting, hardloop Wys alles met die --verbose vlag teken.
• Kan nou gebruik van enige lêer as die pakket of README lêer vir jou dokumentasie. Gebruik die P / - pakket / en -R / -. Readme vlae om die pakket en README lêer spesifiseer
• tipografie en kleurskema Die standaard sjabloon se is aansienlik verbeter.

Wat is nuut in die weergawe 3.3.0:

• Kan nou hardloop Wys alles op Node.js.
• kan nou dieinterface enimplements tags interfaces en hul implementering te dokumenteer.
• Sluiting Compiler seinheritDoc enoverride tags word nou ondersteun.
• As die Wys alles kommentaar vir 'n simbool sluit diemixes tag, al die mixins nou in dokumentasie die simbool se.
• Wys alles kan nou inligting inteken op die console as dit loop (byvoorbeeld, die naam van elke lêer wat Wys alles ontleed). Om hierdie inligting, hardloop Wys alles met die --verbose vlag teken.
• Kan nou gebruik van enige lêer as die pakket of README lêer vir jou dokumentasie. Gebruik die P / - pakket / en -R / -. Readme vlae om die pakket en README lêer spesifiseer
• tipografie en kleurskema Die standaard sjabloon se is aansienlik verbeter.

Wat is nuut in die weergawe 3.2.2 / 3.3.0-beta1:

• Gerig n regressie in Wys alles 3.2.1 wat kan verhoed dat 'n funksie verklaring van oorskadu 'n verklaring met dieselfde naam in 'n buitenste ruimte.
• As 'n kind klas oorheers 'n metode in 'n ouer die klas sonder die dokumentasie van die geïgnoreer metode, die metode dokumentasie se nou kopieer van die ouer klas.
• Jy kan nou gebruik inline HTML tags in Afprijzingsmanager-geformateerde teks. Daarbenewens Wys alles nou gebruik net die gemerkte Afprijzingsmanager parser; die markdown-js parser verwyder is.
• Tipe uitdrukkings kan nou sluit in 'n veel wyer verskeidenheid van herhaalbare tipes. Daarbenewens, kan jy nou gebruik waarvoor geen nul mag en nie waarvoor geen nul mag wysigers Sluiting Compiler se met herhaalbare tipes. Byvoorbeeld, is die soort uitdrukking ...! String ('n herhaalbare, nie waarvoor geen nul mag string) nou reg ontleed.

Wat is nuut in die weergawe 2.4.0:

• Vaste fout wat meervoud simbole bygevoeg met dieselfde naam om docs.
• Bygevoeg steun vir die -M opsie om waarskuwings vir verskeie dokumente te onderdruk.
• Bygevoeg pleister deur brownsea42 om aangehaal gebruiker veranderlikes ondersteun op die opdrag lyn.
• Vaste fout wat soms veroorsaak skakels na die gebeure te wees verkeerd is.

Vereistes :

• JavaScript enabled op die kliënt kant
• Node.js 0,10 of hoër