YUIDoc

YUIDoc is die amptelike dokumentasie generator wat gebruik word deur die Yahoo! span vir die Yahoo! Gebruikerskoppelvlak 3.x (Yui) reeks.

Die app werk deur die skandering JavaScript-kode vir kommentaar, en die gebruik van hulle as dokumentasie vir die kode self.

YUIDoc gebruik kan word om inligting oor eienskappe, persoonlike gebeure, metodes en erfenis JS voorwerpe te dokumenteer.

Behalwe genereer dokumentasie webwerwe uit JavaScript-kode, YUIDoc kom ook met 'n ingeboude in die Web bediener sowel. Hierdie funksie is ingesluit om ontwikkelaars toelaat om 'n voorbeeld dokumentasie webwerwe in real-time, terwyl hulle skryf hul kode en kommentaar.

YUIDoc moet nie verwar word met Yui & nbsp; Doc , 'n soortgelyke dokumentasie generator van Yahoo, maar hoofsaaklik in Python

Wat is nuut. in hierdie release:.

• YUIDoc v0.9.0 ondersteun dokumentasie Custom elemente

Wat is nuut in die weergawe 0.7.0:

• Vaste:
• Skakel oor na ware Afprijzingsmanager opsies as verstek
• Fix 'n fout wat die klas geërf is twee keer ontleed
• Insprong verwyder metode handvatsels alen binne constructor klasse
• Gebruik logFn opset om te meld
• verander:
• Drop verwyder JSHint reëls

Wat is nuut in die weergawe 0.6.0:

• verander:
• Die Afprijzingsmanager parser om markdown-it
• Voeg Node.js v0.12 en io.js in Travis CI opstel
• Vaste:
• 'n fout met die & quot; @ & quot; nie escapable in voorbeeld

Wat is nuut in die weergawe 0.5.0:

• YUIDoc ondersteunthrows tag uiteindelik, en dit sluit meer verenigbaarheid met handvatsels v2.0, uitbreidings, en afhanklikhede updates.

Wat is nuut in die weergawe 0.4.0:

• Ondersteun ES6 styl res parameters sintaksis vir verskeie parameters
• Laat basis URLs vir eksterne skakels
• Voeg --no-soort opsie

Wat is nuut in die weergawe 0.3.49:.

• verander URL skepping om net snare sluit

Wat is nuut in die weergawe 0.3.47:

• Verander linting: Suksesvolle pluis verlaat die CLI, onsuksesvol pluis uitgange van die proses.
• Change pluis sodat proses uitgange net op mislukking.

Vereistes :

• Node.js 0,4 of hoër