Come scrivere commenti C++ visualizzati in Intellisense?

Question

Sto programmando in C++ utilizzando Visual Studio 2010 Ultimate. Voglio documentare alcune funzioni e voglio che la documentazione venga visualizzata in Intellisense.

Secondo MSDN, ho solo bisogno di mettere il commento prima della dichiarazione o dopo sulla stessa riga. Così ho provato questo:

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

Quando si sposta il mouse sopra foo(), il commento non viene visualizzato nella descrizione comandi. Ho anche provato:

• ///
• <summary></summary> tag
• edificio con /doc (impostando il "generare file XML di documentazione" opzione nelle impostazioni di progetto)

non ho avuto fortuna finora. Qualcuno sa come farlo funzionare?

Answer 1

provare a installare e utilizzare Visual Assistdoxigen stile:

/** 
* 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 */ 

}; 

Answer 2

Questo ora supportata in VS 2012!

In precedenza, i tag XML nei commenti venivano letti solo da C++/CLI, non dal vecchio C++. VS 2012 ora porta almeno un po 'di questo in C++ regolare - è nel What's New in Visual Studio 2012 e nei documenti MSDN: XML Documentation (Visual C++).

L'ho provato con la mia applicazione definitiva nel 2012 e posso confermare che i tag riepilogo, para e seealso sono tutti formattati per suggerimenti.

Answer 3

Non ho usato VS2010 è troppi anni per ricordare se questo ha funzionato lì o no. Ma quello che ho fatto per anni in molti diversa versione di VS è ...:

#pragma region foo(float) 
/// <summary> .... </summary> 
/// <param name="bar"> .... </param> 
/// <returns> .... </returns> 
int foo(float bar) 
{ 
    // stuff 
} 
#pragma endregion 

In altre parole, mettere manualmente in esattamente ciò che Visual Studio verrà automagicamente messo dentro per codice C# per voi.

Quindi fornire al motore Intellisense un minuto o più per eseguire nuovamente il file. Fare una build lo costringerà a rimpiazzare, ovviamente.

Come ricordo, questo funziona nella più recente Community Express VS2010, ma non ricordo se ha funzionato in VS2010 Ultimate.

Answer 4

io non sono sicuro di quale versione di Visual Studio che ha introdotto, ma in VS 2015 si può semplicemente mettere un commento di cui sopra function, method, class, struct, union, enum class, namespace o anche singole variabili (locali troppo) ed è sarà mostrato da Intellisense. Se vuoi documentare qualcosa da un modulo diverso, devi scrivere un commento nel file di intestazione. Esempi: