Générateur de documentation Visual Studio c ++
Existe-t-il un moyen d’obtenir de la documentation (comme javadoc) dans un projet visual-c ++?
J'utilise Visual Studio 2010.
merci!
Vous pouvez également utiliser le format XML-Documentation , également pris en charge par VS2010. http://msdn.Microsoft.com/en-us/library/ms177226%28VS.80%29.aspx
Après avoir commenté votre code, vous pouvez utiliser Sandcastle pour créer une documentation de type MSDN: http://sandcastle.codeplex.com/ . (Voici une représentation graphique pour Sandcastle, qui est beaucoup plus facile à utiliser: https://github.com/EWSoftware/SHFB )
J'utilise AtomineerUtils pour créer automatiquement les en-têtes XML-Documentation. Cet outil vous aidera beaucoup. Vous pouvez avoir la version de base gratuite ici: http://www.atomineerutils.com/products.php
Vous pouvez jeter un oeil à Doxygen .
Vous pouvez utiliser mon addin, Documentation Atomineer Pro pour générer rapidement des commentaires de documentation au format Documentation-XML, Doxygen, Qt ou JavaDoc. Ensuite, utilisez Sandcastle (DocXml) ou Doxygen (DocXml, Doxygen, Qt, Javadoc) pour convertir cette documentation en fichiers de documentation externe.
Je vous recommande d'utiliser le format DocXml car tous les outils ci-dessus fonctionnent avec ce dernier, et Visual Studio le reconnaît (sa syntaxe le colore et il construit la documentation dans sa base de données intellisense afin qu'elle apparaisse dans l'aide de l'info-bulle lorsque vous tapez classe/méthode. noms dans votre code).
Regardez aussi CppTripleSlash - Commentaires de doc xml pour c ++ . Il s'agit d'une extension gratuite de Visual Studio 2015, 2013, 2012 et 2010.
Une façon de générer de la documentation est - vous l’avez deviné - javadoc . Vous devez simplement commenter comme vous le faites habituellement, et javadoc les convertit bien en style HTML/LaTeX.
Bien sûr, ce n'est pas la seule solution. Je laisserai de la place aux autres.
Si cela ne vous dérange pas, une documentation écrite à la main, alors sphinx est l’outil parfait.
http://www.sphinx-doc.org/fr/stable/
et voici l'exemple:
sphinx-build -b singlehtml doc/ build/
Si vous utilisez Visual Studio 2015, il existe un générateur Doxygen écrit pour l'extension Macro Explorer, qui utilise JavaScript pour son langage macro.
Le projet est sur github ici: https://github.com/cppocl/visual_studio_macros