当按ctrl + space时,Visual studio显示文档

时间:2011-06-29 07:41:55

标签: .net visual-studio visual-studio-2010 xml-documentation

出于某种原因,我只能看到.net库的文档。有没有办法在Visual Studio中查看我自己的或第三方文档?

我想知道在Visual Studio 2010中按ctrl + space时是否可以看到文档。类似于我在Eclipse中习惯的:)。或者至少在方法或类上单击(选择)以便能够在某种视图(窗口)中查看文档时?

2 个答案:

答案 0 :(得分:4)

  1. 通过在项目属性中启用相应选项(“构建”选项卡)来生成XML文档

  2. 将生成的XML文件放在与DLL相同的文件夹中

答案 1 :(得分:3)

通过“docs”我假设你的意思是Intellisense工具提示?此工具提示将包含XML文档(如果该方法存在)。 MSDN上描述了XML documentation in C#。要向方法添加摘要文档,请添加以///为前缀的特殊注释:

public class Foo {

  /// <summary>
  ///   Bars the foo.
  /// </summary>
  public void Bar() {
  }

}

在VB.Net中,您可以使用相同的XML,但必须使用'''而不是///作为特殊注释字符。

您必须使用/doc选项编译程序集。您可以在项目属性中启用它:

Enabling generation of XML documentation in project properties

如果将生成的XML文件复制到另一个位置,则应该遵循该程序集。