Visual Studio对dll项目的评论

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上使用intellisense了。

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。

Answer 2

要制作用于智能感知功能的XML注释，请按照以下步骤操作：

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

2. To use the generated .xml file for use with the IntelliSense feature，让.xml文件与程序集在同一目录中，我将这2个文件复制到另一个解决方案中并使用XML测试此功能和intellisense评论工作正常如下：