У меня есть некоторый C++ / программное обеспечение CLI, которое все хорошо и зарегистрировано в способ C#'ish, что означает, что DOxygen может вытащить его в некоторый хороший HTML. Есть ли какой-либо способ, которым я могу получить ту же самую информацию для появления в intellisense подсказках способа, которым делает платформа .NET?
Например, позволяет, говорят, что это - мой заголовочный файл (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()
{
}
/// Attempts to fix world hunger
/// The problem to try and fix
/// Whether or not the problem was solved
bool FixWorldHunger( WorldHunger^ problem );
};
}
... и это это - соответствующая реализация:
/*************** MyApp.cpp ***************/
#include "MyApp.h"
using namespace MyNamespace;
MyClass::MyClass()
{
}
bool MyClass::FixWorldHunger( WorldHunger^ problem )
{
bool result = false;
/// TODO: implement something clever
return result;
}
Вот то, что intellisense делает для созданного в функциях, когда я ввожу: http://www.geekops.co.uk/photos/0000-00-02%20%28Forum%20images%29/BrokenIntellisense1.jpg
Вот то, что intellisense делает для моих собственных функций, когда я ввожу: http://www.geekops.co.uk/photos/0000-00-02%20%28Forum%20images%29/BrokenIntellisense2.jpg
Конечно, существует способ сделать это?
Подводя итог, для этого вам нужны комментарии в совместимой форме:
/// <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);
Затем вы просто щелкаете правой кнопкой мыши проект в Visual Studio и перейдите в свойства> свойства конфигурации> C / C ++> Выходные файлы
и измените Создать файлы документации XML
на Да
.
Когда вы перестраиваете свой проект и импортируете его в другое место, вы должны увидеть полностью задокументированные всплывающие подсказки.