DocumentJS fonctionne via la ligne de commande Node.js et permet aux développeurs de créer des sites de documentation sans avoir à faire une double tâche d'écrire des commentaires dans leur code, puis l'expliquer plus tard dans un fichier HTML distinct.
Le site de documentation est créé en utilisant le code source se commente, tout cela automatiquement si les développeurs suivent commentaires de code simples règles de formatage.
DocumentJS supporte des structures simples et syntaxe Markdown, ainsi que la capacité à créer de la documentation versionné, travaillant en synchronisation avec l'histoire de contrôle de version du code.
Dans le cas où le code commente prendre trop de place dans votre source, ils peuvent être exportés dans un fichier Markdown séparé et ensuite attaché vers le code d'origine en utilisant des marqueurs simples.
Cette dernière caractéristique fonctionne très bien pour les grands projets où plus d'une personne travaille sur le code et plus de détails en profondeur sont nécessaires pour chaque fonction, méthode ou paramètre.
.
DocumentJS & nbsp; a été développé pour faire partie du framework JavaScript - JavaScriptMVC
Caractéristiques :
- organisation flexible de votre documentation
- Une visionneuse de documentation intégré où vous pouvez rechercher votre API
- support de Markdown
- Une architecture extensible
Commentaires non trouvées