Dox

Dox analyse du code JavaScript, extraire des commentaires de code et de les assembler dans une page de documentation créés en utilisant Markdown et balises jsdoc.
La page de documentation générée est contenue dans un seul fichier, sans JS externes ou fichiers CSS.
Dox vient comme un outil facile à utiliser exécutable, ainsi que d'un fichier de déploiement unique.
Dox a été construit pour être utilisé à partir de la CLI Node.js seulement

Ce qui est nouveau dans cette version:.

• Ajout:
• Soutien àdescription balise
• correspondance de contexte pour la fermeture de retour
• Tags sans descriptions ont maintenant une propriété HTML contenant un parse de démarque du contenu de la balise
• Corrections:
• Plus agnostique style de code lors de l'analyse des contextes (par exemple, ne tient pas compte des fonctions sans espace entre le nom de la fonction et les parenthèses)
• Pas plus incorrectement tente d'analyser les chaînes à l'intérieur des commentaires, causant de gros morceaux d'un fichier pour être ignorés.
• Pas plus parse double barre oblique dans un littéral de chaîne comme étant un commentaire départ.

Ce qui est nouveau dans la version 0.7.1:

• Ajout:
• Soutien àdescription balise
• correspondance de contexte pour la fermeture de retour
• Tags sans descriptions ont maintenant une propriété HTML contenant un parse de démarque du contenu de la balise
• Corrections:
• Plus agnostique style de code lors de l'analyse des contextes (par exemple, ne tient pas compte des fonctions sans espace entre le nom de la fonction et les parenthèses)
• Pas plus incorrectement tente d'analyser les chaînes à l'intérieur des commentaires, causant de gros morceaux d'un fichier pour être ignorés.
• Pas plus parse double barre oblique dans un littéral de chaîne comme étant un commentaire départ.

Ce qui est nouveau dans la version 0.5.1:

• Correction:
• * / * pauses analyse

Quoi de neuf dans la version 0.4.6:.

• Ne pas envelopperexample contenu avec Markdown

Ce qui est nouveau dans la version 0.4.4:

• Ajout du support pour les noms de variables contenant & quot; $ & quot ;.

Quoi de neuf dans la version 0.4.2:

• Prévenir erreur lors de l'utilisation --api et commentaires ont aucun exemple de code.

Quoi de neuf dans la version 0.4.1:

• Changer # pour. dans --api.

Ce qui est nouveau dans la version 0.4.0:.

• blocs de code de GFM Ajouté
• Retiré titres implicites.

Quoi de neuf dans la version 0.3.3:.

• .Récepteur --api fixe

Ce qui est nouveau dans la version 0.3.1:.

• Titre bug gênant fixe

Quoi de neuf dans la version 0.2.0:.

• Ajout -r, le soutien --raw

Ce qui est nouveau dans la version 0.1.3:

• Ajout:. permettre balises arbitraires
• Correction d'espaces de fonction.

Ce qui est nouveau dans la version 0.1.2:.

• HTML Suppression échappe pour le moment

Ce qui est nouveau dans la version 0.1.1:

• Correction:
• Colons dans les lignes de commentaire ne vise pas les en-têtes.

Quoi de neuf dans la version 0.0.5:

• Ajout de & quot; & quot principale; pour emballer descripteur depuis & quot; & quot répertoires; ne sont plus pris en charge.

Ce qui est nouveau dans la version 0.0.4:

• Ajout du support de la pour inclure un fichier d'intro écrit en Markdown.

Exigences :

• Node.js