Comment obtenir des commentaires complète infobulle IntelliSense travail?
-
19-09-2019 - |
Question
J'ai un logiciel C ++ / CLI qui est tout et bien documenté dans un C # 'ish sorte de chemin qui signifie Doxygen est capable de le sortir dans une belle html. Est-il possible que je peux obtenir ces mêmes informations à apparaître dans les infobulles IntelliSense la façon dont le cadre de .net fait?
Par exemple, permet de dire que c'est mon fichier en-tête (MyApp.h):
/*************** MyApp.h ***************/
/// My namespace containing all my funky classes
namespace MyNamespace
{
using namespace System;
ref class WorldHunger;
/// A truly elegent class which solves all the worlds problems
public ref class MyClass
{
public:
/// Constructs a MyClass
MyClass()
{
}
/// <summary>Attempts to fix world hunger</summary>
/// <param name="problem">The problem to try and fix</param>
/// <returns>Whether or not the problem was solved</param>
bool FixWorldHunger( WorldHunger^ problem );
};
}
... et cela, il est la mise en œuvre correspondant:
/*************** MyApp.cpp ***************/
#include "MyApp.h"
using namespace MyNamespace;
MyClass::MyClass()
{
}
bool MyClass::FixWorldHunger( WorldHunger^ problem )
{
bool result = false;
/// TODO: implement something clever
return result;
}
Voici ce que IntelliSense pour ne construit en fonctions lorsque je tape: http: //www.geekops .co.uk / photos / 0000-00-02% 20% 28Forum% 20images% 29 / BrokenIntellisense1.jpg
Voici ce que IntelliSense fait pour mes propres fonctions quand je tape: http: //www.geekops .co.uk / photos / 0000-00-02% 20% 28Forum% 20images% 29 / BrokenIntellisense2.jpg
Certes, il y a une façon de le faire?
La solution
Pour résumer, pour que cela fonctionne, vous avez besoin de vos commentaires sous une forme compatible:
/// <summary>
/// Retrieves the widget at the specified index
/// </summary>
/// <param name="widgetIndex">Index of the widget to retrieve.</param>
/// <returns>The widget at the specified index</returns>
Widget* GetWidget(int widgetIndex);
Ensuite, vous simplement un clic droit sur le projet dans Visual Studio et allez à properties > configuration properties > C/C++ > Output Files
et changer Generate XML Documentation Files
à Yes
.
Lorsque vous reconstruisez votre importation ad projet un autre endroit, vous devriez voir apparaître infobulles entièrement documentés.