在Visual Studio中附加文档(例如Eclipse)

时间:2014-02-10 03:56:20

标签: c++ eclipse visual-studio visual-studio-2012

我是Visual Studio(2012)的新手,并且来自使用Eclipse,我发现自己错过了将鼠标悬停在某个方法上并接收详细说明参数和任何随附注释的对话的能力。

在这个特定的例子中,我在Visual Studio中使用带有C ++的OpenGL SDK,我希望能够快速获取文档而无需在VS和http://www.opengl.org/sdk/docs/man/之间跳转。

有没有办法可以以某种方式附加文档,以便我可以在Visual Studio中查看它而无需手动搜索?

2 个答案:

答案 0 :(得分:0)

当你徘徊足够长的时间(2-3秒)时,视觉工作室会提供你正在寻找的功能作为工具提示(而不是对话)。为了使其正常工作并且更有用,您需要在代码本身中正确记录这些函数。 有关intellisense工具提示如何工作的更多信息,请查看以下问题: How to get full intellisense tooltip comments working?

Documenting C++/CLI library code for use from c# - best tools and practices?

默认情况下,intellisense只会在函数声明或定义之上显示注释(看起来评论更大,似乎)。当你第一次悬停在某个功能上时需要一段时间,所以请耐心等待并重试:)

答案 1 :(得分:0)

你可以输入代码3斜杠///和visual studio automaticalli为方法/类/属性的文档编写一个xml模板。

接下来你可以进入项目属性。 “构建”选项卡,“输出”部分,XML文档文件,然后输入文件名。它将建立在项目的每个构建上。

如果您不介意使用第三方工具,可以尝试使用NDOC或SandCastle。