Visual Studio 2012 IntelliSense con Visual Assist X e Doxygen

Question

ho usato per scrivere semplici commenti in miei file di intestazione nello stile di

// Returns a new string in which all occurrences of a specified string in the 
// current instance are replaced with another specified string. 
// - strSubject: The string to perform the replacement on. 
// - strOldValue: The string to be replaced. 
// - strNewValue: The string to replace all occurrences of strOldValue. 
static RUNTIME_API String::type Replace 
    (_In_  String::type strSubject, 
    _In_ const String::type& strOldValue, 
    _In_ const String::type& strNewValue); 

tale che Visual Assist visualizza me esattamente questo commento:

Attualmente sto pensando di utilizzare Doxygen per creare una documentazione per il progetto, tuttavia sto cercando di trovare uno stile di documentazione che sia correttamente visualizzato in ToolTips e possa essere analizzato con Doxygen. Per prima cosa stavo pensando di includere i commenti in stile Doxygen nei file * .cpp in modo tale da visualizzare solo i commenti di intestazione. Perciò nel mio file sorgente Ho un commento del tipo

/*! 
* Returns a new string in which all occurrences of a specified string in the 
* current instance are replaced with another specified string. 
* 
* \param strSubject The string to perform the replacement on. 
* \param strOldValue The string to be replaced. 
* \param strNewValue The string to replace all occurrences of strOldValue. 
* 
* \return A string that is equivalent to the current string except that all 
*   instances of strOldValue are replaced with strNewValue. If 
*   strOldValue is not found in the current instance, the method returns 
*   the current instance unchanged. 
*/ 
String::type String::Replace 
    (_In_  String::type strSubject, 
    _In_ const String::type& strOldValue, 
    _In_ const String::type& strNewValue) { /* ... */ } 

Sorprendentemente ottengo due uscite diverse quando si libra questa funzione o quando ottiene Assist visivi "IntelliSense". Passando il Replace rendimenti

mentre il citato IntelliSense produce

tuttavia di spostare il commento stile Doxygen nell'intestazione ha uno strano risultato

Vorrei sapere se hai suggerimenti su come utilizzare i commenti Doxygen in stile Qt, ma se IntelliSense visualizza il tooltip appropriato (quale che sia) e non mostra quelli diversi in base a come lo invoco?Ci deve essere un modo per unificare questo. (In alternativa devo lavorare come sempre e creare intestazioni documentali separate che consistono solo di commenti doxygen - in questo modo non avrò problemi ma avrei dati ridondanti)

Answer 1

L'unico modo semplice (ma brutto) che vedo è aggiungere alcune direttive del preprocessore per rendere Visual Studio ignorarlo come

#if 0 
/*! your comment 
*/ 
#endif 

si consiglia di aggiungere alcune cose dopo la #endif in modo da poter facilmente rimuovere con la ricerca e sostituire senza rimuovere quelle che ti servono. Almeno in VS2013 ignora piuttosto bene i blocchi #if 0. Con questo dovresti essere in grado di lasciarli nello stesso file quindi è meno doloroso.