DocumentJS werkt via de Node.js command-line en stelt ontwikkelaars in staat om documentatie sites te maken zonder dat u een dubbele karwei van het schrijven van commentaar in hun code te doen en dan uit te leggen dat later in een apart HTML-bestand.
De documentatie site is gemaakt met behulp van de broncode zelf zegt, allemaal automatisch als de ontwikkelaars te volgen eenvoudige code opmerkingen opmaakregels.
DocumentJS ondersteunt eenvoudige structuren en Markdown syntax, samen met de mogelijkheid om versiebeheer documentatie te creëren, het werken in sync met de code van versie controle geschiedenis.
In het geval dat de code zegt te veel ruimte in uw bron, kunnen ze worden geëxporteerd naar een afzonderlijk Markdown bestand en dan terug gekoppeld aan de oorspronkelijke code met behulp van eenvoudige markers.
Deze laatste functie werkt prima voor grotere projecten waarbij meer dan één persoon werkt op de code en meer diepgaande gegevens zijn nodig voor elke functie, methode of parameter.
.
DocumentJS & nbsp; is ontwikkeld om een deel van de JavaScript-raamwerk zijn - JavaScriptMVC
Eigenschappen
- Flexibele organisatie van uw documentatie
- Een geïntegreerde documentatie viewer waar u uw API kunt zoeken
- Markdown support
- Een uitbreidbare architectuur
Reacties niet gevonden