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

本文关键字：外部 注释 代码 引用 | 更新日期: 2023-09-27 18:10:18

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

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

这很酷，但它只适用于你的本地代码(在1个项目内)，我怎么能使这些评论是在外部库的函数，这是在另一个项目中引用的，在那个项目中也是可用的?这应该是可能的，因为它适用于。net程序集(当您引用。net库时，您将能够看到该库中函数的这些描述)

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

你可以使用visual studio为你的库生成xml文档，点击这里查看。

"生成XML文档文件"属性决定XML是否文件将在编译过程中生成。你设置了这个属性的编译页面(针对Visual Basic)或构建页面(针对Visual c#)项目设计师。当选择此选项时，XML文档自动发送到XML文件中，该文件将具有相同的项目名称和.xml扩展名，Reference.

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

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

相关文章：