来自DLL项目的Visual Studio注释

Question

我写代码时经常使用以下类似的注释符号。
对于函数/方法/类，有时甚至会针对公共变量。

    /// <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时，那些注释似乎会丢失。是否应该在这些项目中添加某些内容（可能在lib文件夹中）才能恢复这些注释？

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

- Peter

Answer 1

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

需要按照以下步骤进行：

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

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

- Wollmich

---

两个答案都是一样的，但你先回答了。 - Peter

Answer 2

为了使用智能感知功能的XML注释，请按照以下步骤操作：

1. 为您的代码生成.XML文档，右键单击项目名称>属性>生成>输出并选中“XML文档文件:”选项，确保.xml文件的文件名与要支持的程序集相同并保存，然后构建此解决方案。

2. 要使用生成的.xml文件与IntelliSense功能一起使用，请将.xml文件放在与程序集相同的目录中，我将这两个文件复制到另一个解决方案中并测试了此功能和带有XML注释的Intellisense正常工作。

- Sara Liu - MSFT