70 votes

Comment écrire des commentaires C ++ qui apparaissent dans Intellisense?

Je suis à la programmation en C++ à l'aide de Visual Studio 2010 Ultimate. Je veux le document de certaines fonctions et je veux la documentation de montrer dans Intellisense.

Selon MSDN, j'ai juste besoin de mettre le commentaire précédant la déclaration ou après sur la même ligne. J'ai donc essayé ceci:

// This is a test.
void foo();
void bar() { foo(); }

Lors du déplacement de ma souris foo(), le commentaire n'apparaît pas dans l'info-bulle. J'ai aussi essayé:

  • ///
  • <summary></summary> tags
  • Bâtiment avec /doc (par définition de l'option "Générer de la documentation XML files" option dans les paramètres du projet)

Je n'ai pas eu de chance jusqu'à présent. Est-ce quelqu'un connais un moyen de faire ce travail?

17voto

Marcus10110 Points 158

C'est maintenant pris en VS 2012!

Auparavant, les balises XML dans les commentaires étaient seulement lue par C++/CLI, pas un bon vieux C++. VS 2012 maintenant apporte au moins une partie de cette réguliers en C++, il n'est pas dans la MSDN docs aussi loin que je peux voir, mais c'est dans le "Quoi de neuf dans Visual Studio 2012" page.

Je l'ai testé avec ma propre application en 2012 ultimate, et je peux confirmer que le résumé, para, et seealso balises sont tous sorti une formaté pour les info-bulles.

11voto

Ian Medeiros Points 1168

Essayez d'installer Visual Assist et d'utiliser le style doxigen :

 /**
* COMENT OF A CLASS
**/
class Foo
{
   public:
      /**
      *   \brief A foo method.
      *
      *   More complete description of foo.
      *   
      *   \param i A foo parameter.
      *   \return An int
      *
      **/
      int fooMethod(int i);

   private:
      int i; /*!< COMENT OF A MEMBER */

};
 

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X