Visual studio c++ générateur de documentation
Est-il un moyen d'obtenir de la documentation(comme javadoc) dans un visual-projet c++?
Je suis à l'aide de visual studio 2010.
merci!
Vous devez vous connecter pour publier un commentaire.
Est-il un moyen d'obtenir de la documentation(comme javadoc) dans un visual-projet c++?
Je suis à l'aide de visual studio 2010.
merci!
Vous devez vous connecter pour publier un commentaire.
Vous pouvez utiliser le XML-Documentation format, pris en charge par VS2010, trop. http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx
Après de commenter votre code, vous pouvez utiliser de Châteaux de sable pour créer un MSDN-comme la documentation: http://sandcastle.codeplex.com/. (Ici est une interface graphique de représentation pour les Châteaux de sable, ce qui est beaucoup plus facile à utiliser: https://github.com/EWSoftware/SHFB)
- Je utiliser AtomineerUtils pour créer le XML-Documentation-têtes automatiquement. Cet outil va vous aider beaucoup. Vous pouvez avoir gratuitement la version de base ici: http://www.atomineerutils.com/products.php
Vous pouvez avoir un coup d'oeil à Doxygen.
Vous pouvez utiliser mon addin, Atomineer Pro De La Documentation de générer rapidement des commentaires sur la documentation dans des Documents XML, Doxygen, Qt ou format JavaDoc. Ensuite, l'utilisation de Châteaux de sable (DocXml) ou Doxygen (DocXml, Doxygen, Qt, Javadoc) pour convertir cette documentation en externe les fichiers de documentation.
Je le recommande uing DocXml format, parce que tous les outils ci-dessus travailler avec elle, et Visual Studio reconnaît-il (elle syntaxe de couleurs, et il construit les docs dans son intellisense de la base de données de sorte qu'il apparaît dans l'info-bulle de l'aide que vous tapez classe/méthode de noms dans votre code).
Aussi, jetez un oeil à CppTripleSlash - commentaires de document xml en c++. C'est une version gratuite de Visual Studio 2015, 2013, 2012, 2010 extension.
Un moyen de générer de la documentation est - vous l'aurez deviné - javadoc. Il vous suffit de commenter de la même manière que vous faites habituellement, et javadoc fait un bon travail de les convertir en HTML/style LaTeX.
Bien sûr, ce n'est pas la seule solution. Je vais laisser la place aux autres.
Si vous utilisez Visual Studio 2015 puis il y a une Doxygen générateur écrit pour la Macro extension de l'explorateur qui utilise JavaScript pour la macro langage.
Projet est sur github ici: https://github.com/cppocl/visual_studio_macros
Si vous n'avez pas l'esprit, certains écrits à la main de la documentation, puis sphinx est l'outil parfait.
http://www.sphinx-doc.org/en/stable/
et ici est un exemple:
http://ceres-solver.org/