【问题标题】:Attaching Documentation in Visual Studio (à la Eclipse)在 Visual Studio 中附加文档(à la Eclipse)
【发布时间】:2014-03-07 06:58:32
【问题描述】:

我是 Visual Studio (2012) 的新手,使用 Eclipse 后,我发现自己无法将鼠标悬停在方法上并接收详细说明参数和任何随附 cmets 的对话框。

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

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

【问题讨论】:

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


    【解决方案1】:

    当您悬停足够长的时间(2-3 秒)时,Visual Studio 确实提供了您正在寻找的功能作为工具提示(而不是对话)。但是,要使其正常工作且更有用,您需要在代码本身中正确记录函数。 检查以下问题以获取有关智能感知工具提示如何工作的更多信息: How to get full intellisense tooltip comments working?

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

    虽然默认情况下,智能感知只会在函数声明或定义上方显示注释(似乎哪个注释更大)。当您第一次将鼠标悬停在一个函数上时,它需要更长的时间,所以请耐心等待并重试:)

    【讨论】:

      【解决方案2】:

      您可以输入代码 3 斜杠 /// 并且 Visual Studio 会自动为方法/类/属性的文档编写一个 xml 模板。

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

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

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2013-06-29
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2010-09-28
        相关资源
        最近更新 更多