Créer une documentation HTML pour le code C #

Je travaille actuellement sur un projet C # et VisualAssist génère ces commentaires fantaisistes ///

pour moi et je les utilise pour documenter mon code.

Je suppose qu’il doit y avoir un moyen d’utiliser ces commentaires pour créer de la documentation HTML comme ceux de Doxygen ou de Javadoc. Comment je fais ça?

Doxygen ou Sandcastle aide les constructeurs de fichiers à extraire la documentation XML en HTML (et autres formes) de la documentation externe.

Notez que vous pouvez combiner ces exportateurs de documentation avec des générateurs de documentation – comme vous l’avez découvert, Resharper possède des aides rudimentaires, mais il existe également des outils beaucoup plus avancés pour effectuer cette tâche spécifique, tels que GhostDoc (pour code C # / VB avec documentation XML). ) ou mon addin Documentation Atomineer Pro (pour C #, C ++ / CLI, C ++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, Code Unrealscript contenant de la documentation XML, Doxygen, JavaDoc ou Qt).

En 2017, la solution la plus proche de Javadoc serait probablement DocFx, qui a été développé par Microsoft et qui vient en tant qu’outil de ligne de commande ainsi qu’un plug-in VS2017.

C’est toujours un peu rude sur les bords mais ça semble prometteur.

Une autre alternative serait Wyam qui a une recette de documentation appropriée pour les applications réseau. Regardez la documentation du gâteau pour un exemple.

Cette page pourrait vous intéresser: http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

Vous pouvez générer le fichier de documentation XML à l’aide du compilateur de ligne de commande ou de l’interface Visual Studio. Si vous comstackz avec le compilateur en ligne de commande, utilisez les options / doc ou / doc +. Cela générera un fichier XML du même nom et dans le même chemin que l’assembly. Pour spécifier un nom de fichier différent, utilisez / doc: file.

Si vous utilisez l’interface Visual Studio, il existe un paramètre qui contrôle si le fichier de documentation XML est généré. Pour le définir, double-cliquez sur Mon projet dans l’Explorateur de solutions pour ouvrir le Concepteur de projets. Accédez à l’onglet Comstackr. Recherchez “Générer un fichier de documentation XML” en bas de la fenêtre et assurez-vous qu’il est coché. Par défaut, ce paramètre est activé. Il génère un fichier XML en utilisant le même nom et le même chemin que l’assembly.

Vous pouvez essayer https://www.docify.net/ Ils font exactement cela.

La méthode ci-dessus pour Visual Studio ne semblait pas s’appliquer à Visual Studio 2013, mais j’ai pu trouver la case décrite en utilisant le menu Projet et en sélectionnant mon projet (probablement le dernier élément du sous-menu) pour accéder à la boîte de dialog avec le projet. case à cocher (sur l’onglet Construire).