来自 dll 项目的 Visual Studio 注释答案

【问题标题】：Visual studio comments from a dll project来自 dll 项目的 Visual Studio 注释
【发布时间】：2018-03-21 23:54:41
【问题描述】：

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

    /// <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..

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

但是，当我创建一个 .dll 项目时，当我在新项目中使用此类 dll 时，这些 cmets 似乎会丢失。有什么我应该添加到这些项目中（可能在 lib 文件夹中？）以恢复 cmets 吗？

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

【问题讨论】：

标签： c# visual-studio comments intellisense

【解决方案1】：

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

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

【讨论】：

【解决方案2】：

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

需要以下步骤：

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

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

【讨论】：

两个答案都一样，但你是第一个。