如何在引用它的代码中提供外部库中的注释

Question

Visual Studio / monodevelop有很棒的功能，可以让你在每个函数/变量上面指定xml注释，然后当你滚动它，点击它等时显示为该函数的描述。

    /// <summary>
    /// This is example for stack overflow
    /// </summary>
    public void Foo()
    {

    }

这很酷，但它仅适用于您的本地代码（在1个项目中）如何在外部库中创建这些注释，这些注释在另一个项目中引用，也可以在THAT项目中使用？它应该是可能的，因为它适用于.Net程序集（当您引用.Net库时，您将能够看到该库中函数的这些描述）

Answer 1

您可以使用visual studio为您的库的文档生成xml，检查它here。

  

Generate XML文档文件属性确定是否为XML   编译期间将生成文件。您设置此属性   的编译页面（对于Visual Basic）或构建页面（对于Visual C＃）的   项目设计师。选择此选项时，XML文档   自动发送到XML文件，该文件将具有相同的   将name命名为您的项目，将.xml扩展名命名为Reference。

Answer 2

您可以使用/doc，然后将生成的文档与程序集捆绑在一起：

http://msdn.microsoft.com/en-us/library/3260k4x7.aspx