Existe-t-il un outil pour .NET qui génère des explications (commentaires) du code si nous lui donnons des gestionnaires de fonctions ou d'événements (comme GhostDoc qui, selon nous, n'est pas un bon outil) ?
Réponses
Trop de publicités?En fait, ///
ne génère aucune documentation, seulement des balises XML vides. Là où GhostDoc brille, c'est en générant automatiquement une documentation de type MSDN (y compris le verbiage), sur la base d'informations contextuelles telles que la propriété, la classe, la visibilité, l'utilisation, etc.
Voici quelques vraies alternatives :
- Atomineur (un peu moins cher que GhostDoc)
- Resharper (ne fonctionne que si vous activez les commentaires XML pour le projet, mais est loin d'être aussi bon que les deux précédents. peut également copier les commentaires XML des classes/interfaces de base).
Quoi que vous fassiez, ne produisez pas non-documentation ! :)
Si vous commencez un commentaire par /// dans VS2010, il créera des paramètres de base en XML pour vous en fonction de la fonction que vous commentez.
http://msdn.microsoft.com/en-us/magazine/dd722812.aspx
Ainsi, en tapant /// avant la fonction startMonitor(ManagementScope scope)
donne...
/// <summary>
///
/// </summary>
/// <param name="scope"></param>
static void startMonitor(ManagementScope scope)
Si vous souhaitez générer une documentation décente à partir de ces documents, je vous suggère de procéder comme suit https://github.com/EWSoftware/SHFB comme première étape. C'est un vrai régal.
Jetez un coup d'œil à Château de sable . Il fonctionnera avec les projets Visual Studio 2005. Des téléchargements sont également disponibles pour nDoc . Il a connu son heure de gloire vers 2005, mais je pense qu'il n'y a eu que peu ou pas de développement depuis.
Si vous cherchez quelque chose qui va réellement pré-remplir les commentaires de code pour vous, je ne suis pas sûr que vous puissiez faire beaucoup mieux que GhostDoc.
Il n'y a même pas un seul cas sérieux GhostDoc Alternative
- Doxygen de doxygen.nl pour Visual Studio 2005 & 2008
- LuaDoc de github.io/luadoc un outil de génération de documentation pour le code source Lua
- Atomineur de atomineerutils.com seulement 30 jours gratuits
- Château de sable de github.io/SHFB Documentation de l'éditeur du fichier d'aide
- Swagger UI de est swagger.io/tools/swagger-ui/ Outil de documentation de l'API REST
- Daux.io de github.com/dauxio/daux.io est un générateur de documentation pour PHP
J'espère que j'en lancerai un autre moi-même très bientôt.
PS : merci de m'informer si vous trouvez une difficulté, une erreur ou un nouveau problème.