DocumentJS fungerer via Node.js kommandolinje og tillater utviklere å lage dokumentasjon nettsider uten å måtte gjøre en dobbel ork å skrive kommentarer i koden sin, og deretter forklare det senere i en separate HTML-fil.
Dokumentasjonen nettstedet er laget ved hjelp av kildekoden sier seg selv, alt automatisk hvis utviklerne følge enkle kode kommentarer formateringsregler.
DocumentJS støtter enkle strukturer og Markdown syntaks, sammen med evnen til å skape versjon dokumentasjon, som arbeider i sync med koden versjon kontroll historie.
Hvis koden kommenterer ta opp for mye plass i kilde, de kan eksporteres til en egen markdown-fil og deretter bundet tilbake til den opprinnelige koden ved hjelp av enkle markører.
Denne siste funksjonen fungerer bra for større prosjekter hvor mer enn én person arbeider på koden og mer inngående detaljer er nødvendig for hver funksjon, metode eller parameter.
.
DocumentJS & nbsp; ble utviklet for å være en del av Javascript rammeverk - JavaScriptMVC
Egenskaper
- Fleksibel organisering av dokumentasjon
- En integrert dokumentasjon seer hvor du kan søke på API
- Markdown støtte
- En utvidbar arkitektur
Kommentarer ikke funnet