Est-ce que Visual Studio a une option pour générer de la documentation html pour les commentaires de style Javadoc?

Question

Est-ce que Visual Studio a une option pour générer de la documentation html pour les commentaires de style Javadoc? Si oui, quelles sont les étapes nécessaires pour y parvenir?

Dans BlueJ il existe une option pour traduire les commentaires de style Javadoc dans un fichier html.

Comme l'image ci-dessous montre pour Java à l'aide BlueJ je veux faire la même chose avec Visual Studio: http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif

Answer 1

Voulez-vous dire réellement JavaDoc, en Java? Si oui, je ne le crois pas - il suffit d'utiliser javadoc lui-même. Visual Studio ne prend pas vraiment en charge Java. Si vous voulez dire des commentaires de documentation C# XML, vous pouvez modifier les propriétés du projet pour compiler le fichier XML, puis utiliser NDoc (abandonné) ou Sandcastle pour générer du code HTML (ou chm etc). Ce n'est pas aussi facile que cela pourrait l'être, certes.

EDIT: Si vous utilisez C++, vous devriez probablement regarder Doxygen. Il se peut qu'il y ait des plugins Visual Studio, mais il vaut mieux exécuter Doxygen uniquement dans le cadre de votre processus de construction. Si vous utilisez C++/CLI, il peut y avoir un équivalent de commentaires XML C#, mais je ne le connais pas.

Answer 2

Vous pouvez utiliser un style de commentaire compatible Javadoc, soit en saisissant manuellement les commentaires, soit en utilisant mon addin, Atomineer Pro Documentation pour en retirer la plus grande partie du travail. Ensuite, pour générer une documentation externe, utilisez doxygen, qui lit agréablement javadoc. L'alternative est (comme Jon l'a dit) d'utiliser les commentaires au format XmlDoc, qui peuvent être utilisés par Visual Studio (pour les info-bulles intellisense), Atomineer, Sandcastle et Doxygen. C'est un format moins lisible par l'homme, mais qui vous donne des avantages significatifs dans l'environnement Visual Studio, donc c'est un peu plus flexible.

Les deux approches fonctionnent pour C#, C++, C (bien que C# fonctionne mieux sur le côté IntelliSense des choses)