Générer des commentaires de documentation XML pour /// dans Visual Studio 2010 C++

J'ai besoin de commentaire de mon prototype de fonction (écrit en C/C++) avec un résumé, des retours, des balises param. Comment puis-je persuader Visual Studio pour insérer des balises xml après trois barres obliques comme en C#? J'ai trouvé une solution. Quand je renomme xx.h xx.cs dans le projet de C++, je peux utilisez ///pour générer des commentaires xml (IntelliSense dans les commentaires xml fonctionne aussi). Il doit y avoir une meilleure façon, n'est-ce pas?
Il me tuerait à écrire manuellement. Je vous remercie pour toute observation utile.

///<summary>
///
///</summary>
///<param name="aa"></param>
///<returns></returns>
bool function1(TypeX aa);
  • C'est un résultat du C++ et C# langage des équipes à l'aide de différents Intellisense moteurs. Au meilleur de ma connaissance, vous ne serez pas en mesure d'obtenir le C# auto-complétion lors de la typeing /// dans un fichier C++.
  • Pas de. Lorsqu'un fichier cs extension, je peux. Le renommage d'un fichier pour l'écriture de commentaire xml n'est pas approprié, mais il peut aider.
  • Alors que je suis d'accord qu'il doit y avoir moyen de l'IDE pour le faire pour vous, en ce qui concerne It would kill me to write it manually. Vraiment? Si vous êtes suffisamment détaillé dans le texte qui va dans ces blocs de documentation, (de sorte que vous pouvez comprendre comment utiliser le code une fois que vous avez oublié que c'était toi qui l'a écrit), puis la surcharge de la /// et les balises xml n'est pas vraiment beaucoup. 🙂 -- Ou, à monumentale de paraphraser le film Le Treizième Guerrier "Apprendre à taper plus vite." 🙂 🙂
  • C'est vraiment un problème. J'ai voulu arrêter à l'aide de C++ à un certain point seulement à cause de cela.
InformationsquelleAutor user471571 | 2010-10-30
  1. 7

    Cette fonctionnalité n'est pas buit-dans l'. Vous pouvez essayer d'utiliser Visual Studio add-ins. Je n'ai pas utilisé Atomineer Utils Pro De La Documentation moi-même, mais il semble prometteur. Il génère des commentaires de documentation et prend en charge le C++. Il en coûte $10 si.

    • Atomineer Utils est le produit que vous voulez. Après avoir testé la version d'essai gratuite de 10 minutes, j'ai volontiers payé la somme de 10$. Il fonctionne de la même manière que vous attendez si vous avez travaillé avec C# ou VB.
    InformationsquelleAutor Athari
  2. 8

    CppTripleSlash crée xml doc commentaire talons dans les fichiers c++ lors de l' ///est tapé, similaire à ce qui est disponible pour c# dans visual studio. Cela a aussi quelques éléments de base d'intellisense pour remplir les commentaires de document XML.

    • Cela fonctionne brillamment en C++/CLI pour Visual Studio 2015 mise à Jour 2. Nécessite un redémarrage de VS avant de la fonctionnalité des coups de pied dans.
    • Je ne peux pas le recommander. Il demande aux développeurs de modifier leur code afin de travailler dans tous les cas, ce qui est un no-go pour un outil qui ne fait qu'ajouter des commentaires. En outre, il ne se comporte pas comme ce que nous sommes habitués avec C# et donne parfois plus de travail. Par exemple, il n'a pas d'insérer /// dans de nouvelles lignes et bêtement insère <summary> balises à chaque fois que vous entrez triple slash.
    InformationsquelleAutor tcb
  3. 6

    GhostDoc allons maintenant insérer des commentaires XML en C++ éléments. Vient de mettre le curseur sur un élément, puis appuyez sur Ctrl+Maj+D.

    GhostDoc a une version gratuite pour un usage personnel qui le font déjà.

    InformationsquelleAutor Daniel A.A. Pelsmaeker
  4. 4

    Pour le C++/CLI

    Ces instructions fonctionnent bien pour Visual Studio 2015 Update 2.

    Premier, tour documentation XML sur. Cela génère un fichier de métadonnées, ce qui signifie que les commentaires seront visibles de l'extérieur, notamment en C#.

    Générer des commentaires de documentation XML pour ///dans Visual Studio 2010 C++

    Suivante, conformément à la réponse de @tcb, installer CppTripleSlash. Redémarrez Visual Studio, et vous devriez être bon d'aller.

    InformationsquelleAutor Contango
  5. 1

    Ont un coup d'oeil à ce complément:
    GhostDoc

    InformationsquelleAutor Florian
  6. 0

    Dans Visual Studio 2010, C++, vous pouvez définir des macros pour insérer des choses pour vous.

    Définir une macro pour insérer la fonction de base de l'en-tête résumé ligne.

    ///<summary> </summary>

    Un autre pour un vide param ligne, l'autre pour le retour de la ligne.

    ///<param name=""> </param>

    et

    ///<returns> </returns>

    Qui va couvrir la plupart de vos besoins avec seulement trois macros. Si vous utilisez assez, puis ajouter une macro pour ///<remarks></remarks> et ///<exception name=""></exception> et <see cref=""/> et de tout vous n'utilisez pas assez pour faire une macro pour, vous devrez entrer manuellement.

    Oui, vous devrez taper le nom du paramètre manuellement. 🙂 Les Macros peuvent pas tout faire. 🙂

    Voir: MSDN : VS2010 : Comment Enregistrer des Macros

    Voir: MSDN : VS2010 : Comment faire pour Exécuter des macros

    Mise à JOUR: j'étais pas au courant de ces discussions, lorsque j'ai écrit cette réponse:

    DONC: les Macros ne fonctionnent pas dans VS2010

    MS: les Macros cassé dans VS2010 par le correctif de sécurité Fév 2014 (avec une solution de contournement proposée)

    InformationsquelleAutor Jesse Chisholm
  7. 0

    Cela s'applique à C++/CLI

    Une autre façon est d'utiliser des ILSpy pour convertir C++/CLI code C#. Puis, en C#, vous êtes capable d'écrire des commentaires avec IntelliSence de soutien. Ensuite il suffit de copier les commentaires dans le C++/CLI projet, de compiler et que vous êtes bien 🙂

    Configurer Visual Studio (2013) à utiliser ILSpy

    1. Télécharger le ILSpy binaire
    2. Ajouter une nouvelle entrée outils dans Visual Studio en ouverture "Outils /Outils Externes /Ajouter".
    3. Là, entrez le chemin d'accès à ILSpy.exe de Commande, $(TargetPath) pour les Arguments et $(TargetDir) pour le répertoire Initial.
    4. Appliquer et fermer la fenêtre.
    5. (Une nouvelle entrée s'affiche dans l'onglet Outils)
    6. Créer un nouveau projet C#.

    Utiliser

    Si vous ouvrez n'importe quel fichier de la C++/CLI projet et activer la nouvelle entrée dans l'onglet Outils, une fenêtre (ILSpy) apparaît à l'affichage de votre assemblée converti en code C#. Copier ce code dans un fichier situé dans le projet C# et écrire des commentaires XML.

    InformationsquelleAutor Christian St.