Recherche de documentation automatique de l'API solution wiki basée sur jsdoc

Question

Nous avons un gros morceau de code JS, documenté avec la syntaxe jsdoc, que nous aimerions inclure dans le wiki interne de manière automatisée.

Par conséquent, je suis à la recherche d'une solution wiki capable de générer automatiquement des pages avec jsdoc à partir de notre base de code.

Une idée?

Answer 1

Vous pouvez utiliser la fonction intégrée de JSDoc pour générer à partir de la source et lui appliquer votre propre modèle. Ensuite, à partir de votre WIKI, vous venez de créer un lien vers les pages HTML générées. Vous pouvez automatiser cela en utilisant cron pour lancer le générateur de pages de JSDoc à chaque fois et utiliser sa fonctionnalité de modèle pour qu'il ressemble exactement à votre wiki, donc quand vous le liez à partir de votre wiki, cela n'a pas l'air différent. Ceci est ce que nous faisons.

Answer 2

1. D'abord, je recommande à vérifier si le code d'application a une jsdoc valide et complète en utilisant eslint: valid-jsdoc.

2. D'un jsdoc valide peut être généré:

   • Utilisez le générateur de modèle par défaut de jsdoc
   • Un outil simple docdown, qui génère démarquage
   • Un Docdash plus complexe avec des options comme modèles (lodash. com like), configuration de l'exportation, etc. Il génère un html complet.