documentation - 如何获得完整的智能感知工具提示评论？

Question

我有一些 C++/CLI 软件，它们都很好，并且以 C# 风格的方式记录，这意味着 DOxygen 能够将其提取到一些不错的 html 中。有什么方法可以让相同的信息以 .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()
                    {

                    }


                    /// <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 );
            };
    }

...这是相应的实现:

    /*************** MyApp.cpp ***************/

    #include "MyApp.h"

    using namespace MyNamespace;

    MyClass::MyClass()
    {

    }

    bool MyClass::FixWorldHunger( WorldHunger^ problem )
    {
            bool result = false;

            /// TODO: implement something clever

            return result;
    }

这是我输入时智能感知对内置函数的作用:
http://www.geekops.co.uk/photos/0000-00-02%20%28Forum%20images%29/BrokenIntellisense1.jpg

以下是我输入时智能感知对我自己的功能所做的事情:
http://www.geekops.co.uk/photos/0000-00-02%20%28Forum%20images%29/BrokenIntellisense2.jpg

当然有办法做到这一点吗？

Answer 1

总而言之，要使其正常工作，您需要以兼容的形式发表评论:

/// <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 中右键单击该项目并转到 properties > configuration properties > C/C++ > Output Files并更改 Generate XML Documentation Files至 Yes .

当您重建您的项目并将其导入其他地方时，您应该会看到完整记录的工具提示出现。