Créer une documentation html pour le code C #
Je travaille actuellement sur un projet C # et VisualAssist génère ces fantaisies /// <summary></summary> _ commentaires pour moi et je les utilise consignent mon code.
Je suppose qu'il doit exister un moyen d'utiliser ces commentaires pour créer une documentation HTML comme celle réalisée par Doxygen ou Javadoc. Comment je fais ça?
Doxygen ou constructeur de fichiers d'aide de Sandcastle sont les principaux outils permettant d'extraire la documentation XML en HTML (et autres formes) de 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 dispose d’aides rudimentaires, mais il existe également des outils beaucoup plus avancés pour effectuer cette tâche spécifique, tels que GhostDoc (for Code C #/VB avec documentation XML) ou mon complément documentation Atomineer Pro (pour C #, C++/CLI, C++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, code Unrealscript contenant du code XML, Documentation Doxygen, JavaDoc ou Qt).
En 2017, l'élément le plus proche de Javadoc serait probablement DocFx , qui a été développé par Microsoft et se présente sous la forme d'un outil de commande ainsi que d'un plug-in VS2017.
C'est toujours un peu difficile sur les bords mais cela semble prometteur.
Une autre alternative serait Wyam qui propose une recette de documentation adaptée aux applications réseau. Regardez le documentation du gâtea 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 compilez avec le compilateur en ligne de commande, utilisez 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: fichier.
Si vous utilisez l'interface Visual Studio, un paramètre détermine 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 projet. Accédez à l'onglet Compiler. Recherchez "Générer le 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 d'accès que l'Assembly.
La méthode ci-dessus pour Visual Studio ne semblait pas s'appliquer à Visual Studio 2013, mais j'ai pu trouver la case à cocher décrite à l'aide du menu Projet et en sélectionnant mon projet (probablement le dernier élément du sous-menu) pour accéder à la boîte de dialogue case à cocher (sous l'onglet Construire).