Dox analyserer Javascript-kode, trekke kode kommentarer og montering dem inn i et dokumentasjons side opprettet med Markdown og JSDoc koder.
Den genererte dokumentasjonssiden finnes i én fil, uten eksterne JS eller CSS-filer.
Dox kommer som en enkel å bruke kjørbar, så vel som en enkelt fil distribusjon.
Dox ble bygget for å brukes fra Node.js CLI bare
Hva er nytt i denne utgaven.
- Lagt:
- Støtte fordescription tag
- Kontekst kamp for returnert nedleggelse
- Tags uten beskrivelser har nå en HTML eiendommen inneholder en markdown parse av brikkenes innholdet
- Løser:
- Mer agnostiker å kode stil når parsing sammenhenger (for eksempel ikke lenger ignorerer funksjoner uten mellomrom mellom funksjon og parentes)
- forsøker ikke lenger feil å analysere strenger inne kommentarer, forårsaker store biter av en fil til å bli ignorert.
- Ikke lenger analyserer dobbel skråstrek i en streng bokstavelig som en kommentar start.
Hva er nytt i versjon 0.7.1:
- Lagt:
- Støtte fordescription tag
- Kontekst kamp for returnert nedleggelse
- Tags uten beskrivelser har nå en HTML eiendommen inneholder en markdown parse av brikkenes innholdet
- Løser:
- Mer agnostiker å kode stil når parsing sammenhenger (for eksempel ikke lenger ignorerer funksjoner uten mellomrom mellom funksjon og parentes)
- forsøker ikke lenger feil å analysere strenger inne kommentarer, forårsaker store biter av en fil til å bli ignorert.
- Ikke lenger analyserer dobbel skråstrek i en streng bokstavelig som en kommentar start.
Hva er nytt i versjon 0.5.1:
- Fast:
- * / * pauser parsing
Hva er nytt i versjon 0.4.6.
- Ikke pakkexample innholdet med Markdown
Hva er nytt i versjon 0.4.4:
- Lagt til støtte for variabelnavn som inneholder & quot; $ & quot ;.
Hva er nytt i versjon 0.4.2:
- Unngå feil ved bruk --api & kommentarer har ingen eksempelkode.
Hva er nytt i versjon 0.4.1:
- Endre # til. i --api.
Hva er nytt i versjon 0.4.0.
- Lagt GFM kodeblokker
- Fjernet implisitte titler.
Hva er nytt i versjon 0.3.3.
- Fast --api .receiver
Hva er nytt i versjon 0.3.1.
- Fast irriterende tittelen bug
Hva er nytt i versjon 0.2.0.
- Lagt -r, --raw støtte
Hva er nytt i versjon 0.1.3:
- Lagt:. tillate vilkår tags
- Fast funksjon mellomrom.
Hva er nytt i versjon 0.1.2.
- Fjernet HTML rømmer for nå
Hva er nytt i versjon 0.1.1:
- Fast:
- Kolon i kommentar linjer ikke ment som overskrifter.
Hva er nytt i versjon 0.0.5:
- Legge & quot; main & quot; å pakke descriptor siden & quot; kataloger & quot; støttes ikke lenger.
Hva er nytt i versjon 0.0.4:
- Lagt --intro støtte for blant annet en intro fil skrevet i Markdown.
Krav
- Node.js
Kommentarer ikke funnet