Question

在大学期间，我学会了编写Java，我在Eclipse中做过。我喜欢Eclipse中关于Javadoc注释如何能够在窗口中弹出的功能。目前我正在编程C ++，我真的开始错过这个功能了。

这就是我要问的原因：是否有插件可以达到同样的效果。目前我正在使用Visual Studio Express 2010编写c ++，除了在自动完成窗口中显示功能界面之外没有这样的东西。我想阅读更多信息，例如阅读前后条件，或者是来自现有库的代码（如果它们存在），或者仅用于我自己编写的代码。

现在我知道Doxygen，但它并不是我想要的。这是一个足够好的后退机制，但我真的很想从同一个窗口随时可以看到我正在编写我的代码。

Visual Studio是否存在类似的内容？或者我可以开始使用Eclipse的C ++版本并在那里运行Javadoc生成器（我实际上没有尝试过这个！）来获得那些不错的弹出式注释？

编辑：我一直在努力让XML风格的评论有效，但是有点像：

/// <summary>This constructor takes parameters to set the 
/// members of the Cow class.
/// <param name="ho">Hobby as string of the cow.</param>
/// <param name="wt">Weight of the cow as a double.</param>
/// </summary>
Cow(const char * nm, double wt);

仍然只在弹出窗口中给我字符串“Cow（const char * nm，double wt）”。使用\ doc选项构建，我确实生成了一个.xml文件（在我的Debug文件夹中）。

Answer 1

在C＃中你可以写

///

它将生成一个XML样式的注释，如：

/// <summary>
///
/// </summary>
/// <param name="parameter"> </param>
/// <returns> </returns>

您可以让Visual Studio生成一个XML文件，可以对其进行处理以获得类似javadoc的内容。我100％肯定它适用于C＃，但似乎C ++使用不同的风格。如果我去项目选项＆gt;配置选项＆gt; XML文档生成器＆gt;常规，并将“验证IntelliSense”设置为是，您可以在.h文件中添加注释：

class Test {
    public:
        // The constructor
        Test(void);
        // The destructor
        ~Test(void);
        // The function description
        void Function();
};

如果我去我的main.cpp，请输入：

Test * test = new Test();
test->

当我点击'＆gt;'时，会弹出一个包含函数列表的框（析构函数和本例中的函数）。例如，如果我选择Function，则弹出一个工具提示“功能描述”：

void Test::Function();

The function description
File: test.h

我不确定是否有任何插件，但我希望我能在这里帮助你一点！

Answer 2

如果你有CodeRush / Refactor，你可以试试CR_Documenter插件（使用VS Extension Manager）。它提供了一个带有这种文档的新的可停靠窗口。

我和你在一起 - Eclipse在查看文档方面要好得多。

Answer 3

使用SandCastle与内置帮助（F1）集成。它不如你在Eclipse中的内联帮助那么好，但你可以将鼠标悬停在一个类型上，按F1然后你就在那里。

为此，请安装Sandcastle和Sandcastle帮助文件生成器。然后在Sandcastle帮助文件生成器项目中，确保勾选MSHelpViewer的复选框。这将生成文档和脚本，您可以运行该脚本将自定义文档集成到F1帮助中。

注释C ++（Visual Studio）的弹出窗口，类似于Eclipse和Javadoc

3 个答案: