Visual studio 来自 dll 项目的评论

Question

当我编写代码时，我经常使用如下注释符号。
对于函数/方法/classes，有时甚至对于 public 变量。

    /// <summary>
    /// Constructor of the process runner class.
    /// </summary>
    /// <param name="Name">The exe name of the application ea notead.exe</param>
    /// <param name="Processrunner">A Process instance to start</param>
    Public ProcesRunner(.....bla bla bla..

当 class 和程序都在同一个项目中时，这很有效。

然而，当我创建一个 .dll 项目时，当我在一个新项目中使用这样的 dll 时，这些注释似乎丢失了。有什么我应该添加到这些项目（也许在 lib 文件夹中？）以取回评论的东西吗？

这样我也可以在这些 dll 上使用智能感知。

Answer 1

为您的项目（您的 dll）生成 XML 文档，请参阅 https://msdn.microsoft.com/en-us/library/x4sa0ak0(v=vs.100).aspx。

需要以下步骤：

在解决方案资源管理器中 select 编辑了一个项目，在“项目”菜单上单击“属性”。
单击构建选项卡。
在构建页面上，select XML 文档文件。默认情况下，文件创建在指定的输出路径下，例如 "bin\Debug\Projectname.XML".

现在，如果您在另一个解决方案中使用您的 dll，并且您还为其构建了 XML 文档文件，那么 Intellisense 将适用于您的 dll。

Answer 2

要使 XML 评论与智能感知功能一起使用，请按照以下步骤操作：

为您的代码生成the .XML documentation，右键单击项目名称>属性>构建>输出并选中选项“XML文档文件：”，确保 .xml 文件的文件名与您要支持的程序集相同 并保存，然后构建此解决方案
To use the generated .xml file for use with the IntelliSense feature，让.xml文件与程序集在同一目录，我将这2个文件复制到另一个解决方案并测试此功能和带有 XML 注释的智能感知工作正常，如下所示：

Visual studio 来自 dll 项目的评论

Visual studio comments from a dll project

c#

intellisense

comments

visual-studio