YUIDoc

YUIDoc er offisiell dokumentasjon generator brukes av Yahoo! team for Yahoo! Brukergrensesnitt 3.x (YUI) serie.

Den app fungerer ved scanning Javascript-kode for kommentarer, og bruker dem som dokumentasjon for selve koden.

YUIDoc kan brukes til å dokumentere informasjon om egenskaper, egendefinerte hendelser, metoder og arv for JS stedene.

I tillegg til å generere dokumentasjon nettsider ut av Javascript-kode, YUIDoc kommer også med en innebygd Web-server også. Denne funksjonen ble tatt med for å tillate utviklere å forhåndsvise dokumentasjon nettsteder i sanntid, mens de skriver koden sin og kommentarer.

YUIDoc må ikke forveksles med YUI & nbsp; Doc , en tilsvarende dokumentasjon generator fra Yahoo, men hovedsakelig skrevet i Python

Hva er nytt. i denne utgaven.

• YUIDoc v0.9.0 støtter dokumentere Custom Elements

Hva er nytt i versjon 0.7.0:

• Fast:
• Bytt til ekte Markdown alternativer som standard
• Fix en bug som arvet klassen ble analysert to ganger
• unindent metode Styre partials innenfor konstruktør klasser
• Bruk logFn konfigurasjon for å logge
• Endret:
• Drop fjernet JSHint regler

Hva er nytt i versjon 0.6.0:

• Endret:
• Markdown parser til markdown-it
• Legg Node.js v0.12 og io.js i Travis CI innstilling
• Fast:
• En bug med & quot; @ & quot; ikke escapable i eksempel

Hva er nytt i versjon 0.5.0:

• YUIDoc støtterthrows tag til slutt, og det inkluderer mer kompatibilitet med Styre v2.0, forbedringer og avhengig oppdateringer.

Hva er nytt i versjon 0.4.0:

• Støtter ES6 stil resten Parametere syntaks for flere parametere
• Gir grunn webadresser for eksterne lenker
• Legger --no-sorteringsalternativ

Hva er nytt i versjon 0.3.49.

• Endret URL skapelse å bare bli med strenger

Hva er nytt i versjon 0.3.47:

• Endre linting: Vellykket lo avslutter CLI, mislykket lo avslutter prosessen.
• Endre lo slik at prosessen bare går ut på å mislykkes.

Krav

• Node.js 0,4 eller høyere