web-dev-qa-db-fra.com

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

J'ai besoin de commenter mon prototype de fonction (écrit en C/C++) avec un résumé, des retours, des balises param. Comment persuader Visual Studio d'insérer des balises XML après trois barres obliques, comme en C #? J'ai trouvé une solution. Lorsque je renomme xx.h xx.cs dans un projet C++, je peux utiliser /// pour générer des commentaires xml (IntelliSense dans les commentaires xml fonctionne également). Il doit y avoir une meilleure façon, ne devrait pas là? Cela me tuerait de l’écrire manuellement. Je serai reconnaissant pour chaque commentaire utile.

/// <summary>
/// 
/// </summary>
/// <param name="aa"></param>
/// <returns></returns>
bool function1(TypeX aa);
c++xmlcomments
26
user471571

Cette fonctionnalité n'est pas intégrée. Vous pouvez essayer d’utiliser les compléments Visual Studio . Je n'ai pas utilisé Atomineer Utils Pro Documentation moi-même, mais cela semble prometteur. Il génère des commentaires sur la documentation et prend en charge C++. Cela coûte 10 $ si.

7
Athari

CppTripleSlash crée des stubs de commentaires de doc xml dans les fichiers c ++ lorsque /// est saisi, comme ce qui est disponible pour c # dans visual studio. Cela a aussi quelques bases de base pour compléter les commentaires XML doc.

8
tcb

GhostDoc ============================== C++. Просто наведите курсор на элемент et нажмитеCtrl+Shift+D,.

GhostDoc est le système qui convient le mieux à vos besoins.

6
Daniel A.A. Pelsmaeker

Pour C++/CLI

Ces instructions fonctionnent bien pour Visual Studio 2015 Update 2.

Commencez par activer la documentation XML. Cela génère un fichier de métadonnées, ce qui signifie que les commentaires seront visibles de l'extérieur, y compris en C #.

 enter image description here

Ensuite, selon la réponse de @tcb, installez CppTripleSlash . Redémarrez Visual Studio et vous devriez être prêt à partir.

3
Contango

Jetez un coup d’œil à ce complément: GhostDoc

1
Florian

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

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

/// <summary> </summary>

Un autre pour une ligne de paramètre vide, un autre pour une ligne de retour.

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

et

/// <returns> </returns>

Cela couvrira la plupart de vos besoins avec seulement trois macros. Si vous les utilisez suffisamment, ajoutez une macro pour /// <remarks></remarks> et /// <exception name=""></exception> et <see cref=""/>. Toute macro que vous n'utilisez pas assez pour créer une macro est nécessaire pour la saisie manuelle.

Oui, vous devrez taper le nom du paramètre manuellement. :) Les macros ne peuvent pas tout faire. :)

Voir: MSDN: VS2010: comment enregistrer des macros

Voir: MSDN: VS2010: comment exécuter des macros

UPDATE: Je n'étais pas au courant de ces discussions lorsque j'ai écrit cette réponse:

SO: Les macros ne fonctionnent pas dans VS2010

MS: Macros endommagées dans VS2010 par un correctif de sécurité, février 2014 (avec une solution de contournement suggérée)

0
Jesse Chisholm

Ceci s'applique à C++/CLI

Une autre méthode consiste à utiliser ILSpy pour convertir le code C++/CLI en C # . Ensuite, en C #, vous pouvez écrire des commentaires avec le support IntelliSence. Ensuite, copiez simplement les commentaires dans le projet C++/CLI, compilez et tout va bien :-)

Configurer Visual Studio (2013) pour utiliser ILSpy

  1. Téléchargez le binaire ILSpy
  2. Ajoutez une nouvelle entrée d'outils dans Visual Studio en ouvrant "Outils/Outils externes/Ajouter".
  3. Là, entrez le chemin vers ILSpy.exe pour Command, $(TargetPath) pour Arguments et $(TargetDir) pour le répertoire initial.
  4. Appliquez et fermez la fenêtre.
  5. (Une nouvelle entrée apparaît dans l'onglet Outils)
  6. Créez un nouveau projet C # vide.

Utilise le

Si vous ouvrez un fichier du projet C++/CLI project et activez la nouvelle entrée dans l'onglet Outils, une fenêtre (ILSpy) apparaît et affiche votre ensemble converti en code C #. Copiez ce code dans un fichier situé dans le projet C # et écrivez des commentaires XML. 

0
Christian St.