DocumentJS fejtik node.js parancssori és lehetővé teszi a fejlesztők számára, hogy hozzon létre dokumentáció oldalakat, anélkül, hogy egy dupla házimunka írásban észrevételeket a saját kódját, és elmagyarázza, hogy egy későbbi külön HTML fájlt.
A dokumentáció oldalon létre a forráskód kommentek magukat, minden automatikusan, ha a fejlesztők követni az egyszerű kódot megjegyzéseket formázási szabályokat.
DocumentJS támogatja az egyszerű struktúrák és Markdown szintaxis, valamint a képesség, hogy hozzon létre verzióval dokumentációt, szinkronban dolgoznak a kód verziókezelő történetében.
Ha a kód megjegyzések vesz el túl sok helyet foglal el a forrás, akkor lehet exportálni egy külön Markdown fájlt, majd kötötte vissza az eredeti kódot egyszerű markerek.
Ez utóbbi tulajdonság jól működik a nagyobb projektek esetében, ahol egynél több személy dolgozik a kódot, és alaposabb adatok szükségesek az egyes funkciókhoz, módszer, illetve paraméter.
DocumentJS & nbsp; alakult, hogy részt vesz a JavaScript keretrendszer - JavaScriptMVC .
Tulajdonságok :
- Rugalmas szervezet a dokumentáció
- Egy integrált dokumentációs nézőt, ahol kereshet az API
- Markdown támogatás
- A bővíthető architektúra
Hozzászólás nem található