DocumentJS fungerer via node.js kommando-line og giver udviklere mulighed for at skabe dokumentation sites uden at skulle gøre en dobbelt opgave at skrive kommentarer i deres kode og derefter forklare det senere i en separat HTML-fil.
Dokumentationen site er skabt ved hjælp af kildekoden kommentarer selv, alle automatisk, hvis udviklerne følge enkle kode kommentarer formatering regler.
DocumentJS understøtter simple strukturer og Markdown syntaks, sammen med evnen til at skabe versioneret dokumentation, der arbejder i sync med koden version kontrol historie.
Hvis koden kommentarer fylder for meget plads i din kilde, de kan eksporteres til en separat Markdown fil og derefter bundet tilbage til den oprindelige kode ved hjælp af simple markører.
Denne sidste funktion fungerer fantastisk til større projekter, hvor mere end en person arbejder på koden og der er behov mere dybdegående detaljer for hver funktion, metode, eller parameter.
.
DocumentJS & nbsp; blev udviklet til at være en del af rammen JavaScript - JavaScriptMVC
Funktioner :
- Fleksibel organisering af din dokumentation
- En integreret dokumentation fremviser hvor du kan søge din API
- Markdown støtte
- En Extensible arkitektur
Kommentarer ikke fundet