C# 如何使外部库中的注释在引用它的代码中可用

C# 如何使外部库中的注释在引用它的代码中可用,c#,visual-studio-2010,C#,Visual Studio 2010,VisualStudio/monodevelop有一个很棒的特性,可以让您在每个函数/变量上面指定xml注释,当您滚动到它上面、单击它时,这些注释将显示为该函数的描述 /// <summary> /// This is example for stack overflow /// </summary> public void Foo() { } // ///这是堆栈溢出的示例 /// 公共图书馆 { } 这很酷,但它

VisualStudio/monodevelop有一个很棒的特性,可以让您在每个函数/变量上面指定xml注释,当您滚动到它上面、单击它时,这些注释将显示为该函数的描述

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

    }
//
///这是堆栈溢出的示例
/// 
公共图书馆
{
}

这很酷,但它只在本地代码中起作用(在1个项目中)。如何使外部库中的函数中的这些注释(在另一个项目中引用)也在该项目中可用?这应该是可能的,因为它适用于.Net程序集(当您引用.Net库时,您将能够看到该库中函数的这些描述)

您可以使用visual studio为库的文档生成xml,请检查它

Generate XML documentation file属性确定XML 文件将在编译期间生成。将此属性设置为 的编译页(对于Visual Basic)或生成页(对于Visual C#) 项目设计师。选择此选项后,XML文档 自动发送到XML文件中,该文件将具有相同的 名称为您的项目和.xml扩展名


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


您需要将它放在相关程序集所在的目录中。这是重要的信息,因为例如monodevelop在构建选项中没有“生成XML文档文件”,但您可以将/doc附加到编译器参数+1中