DocumentJS ay gumagana sa pamamagitan ng Node.js command-line at nagbibigay-daan sa mga developer na lumikha ng mga babasahin sites nang hindi na kinakailangang gumawa ng isang double gawaing-bahay ng pagsulat ng mga komento sa kanilang mga code at pagkatapos ay nagpapaliwanag ito sa ibang pagkakataon sa isang hiwalay na HTML file.
Ang mga babasahin site ay nilikha gamit ang source code comments sa kanilang sarili, ang lahat ng awtomatikong kung ang mga developer sundin ang mga simpleng mga komento code formatting patakaran.
DocumentJS sinusuportahan simple istruktura at Markdown syntax, kasama ang kakayahan upang lumikha ng versioned dokumentasyon, nagtatrabaho sa sync kasama ang bersyon ng control kasaysayan ng code ni.
Sa kaso ng code comments umabot ng masyadong maraming space sa iyong source, maaari nilang i-export sa isang hiwalay na Markdown file at pagkatapos ay nakatali pabalik sa orihinal na code gamit ang mga simpleng mga marker.
Ang huli tampok ay gumagana ng mahusay para sa mas malaking proyekto na kung saan higit sa isang tao ay gumagana sa mga code at higit pa sa malalim na mga detalye ay kinakailangan para sa bawat function, pamamaraan, o parameter.
.
DocumentJS & nbsp; ay binuo upang maging bahagi ng framework JavaScript - JavaScriptMVC
Mga Tampok
- Flexible organisasyon ng iyong dokumentasyon
- Ang isang pinagsamang dokumentasyon viewer kung saan maaari kang maghanap sa iyong mga API
- Markdown suporta
- Ang isang extensible architecture
Mga Komento hindi natagpuan