2

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

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

    }

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

4

2 回答 2

3

您可以使用 Visual Studio 为您的库文档生成 xml,请在此处查看

生成 XML 文档文件属性确定是否在编译期间生成 XML 文件。您可以在项目设计器的编译页面(对于 Visual Basic)或构建页面(对于 Visual C#)上设置此属性。选择此选项后,XML 文档会自动发送到一个 XML 文件中,该文件将与您的项目具有相同的名称和 .xml 扩展名Reference

于 2013-04-21T17:35:57.597 回答
2

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

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

于 2013-04-21T17:37:15.417 回答