DocumentJS funcționează prin intermediul liniei de comandă Node.js și permite dezvoltatorilor să creeze site-uri de documentare, fără a fi nevoie să facă o dublă corvoada de a scrie comentarii în codul lor și apoi explicând ulterior într-un fișier HTML separat.
Site-ul de documentare este creat folosind codul sursă ele însele comentarii, toate în mod automat în cazul în care dezvoltatorii urmează simplu observații codul de formatare reguli.
DocumentJS suporta structuri simple și sintaxa Markdown, împreună cu capacitatea de a crea documentație versionate, care lucrează în sincronizare cu istoric de control al versiunii codului lui.
În cazul în care codul comentarii ocupă prea mult spațiu în sursa ta, ele pot fi exportate într-un fișier separat și apoi Markdown legat înapoi la codul original, folosind markeri simplu.
Această ultimă caracteristică funcționează mare pentru proiecte mai mari în cazul în care mai mult de o persoană care lucrează pe codul și sunt necesare mai multe detalii în profunzime pentru fiecare funcție, metodă sau un parametru.
.
DocumentJS & nbsp; a fost dezvoltat pentru a fi parte a cadrului JavaScript - JavaScriptMVC
Caracteristici :
- organizarea flexibilă a documentației
- O documentație de vizualizare integrat în cazul în care puteți căuta API-ul
- sprijin Markdown
- O arhitectură extensibilă
Comentariile nu a fost găsit