从一个dll项目的视觉工作室评论

问题描述:

当我编写代码时,我经常使用下面的注释符号。
函数/方法/类,有时甚至是公共变量。从一个dll项目的视觉工作室评论

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

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

以下步骤:

  1. 随着Solution Explorer中选择一个项目,在项目菜单上,单击属性。
  2. 单击生成选项卡。
  3. 在生成页面上,选择XML文档文件。默认情况下,该文件是在指定的输出路径下创建的,例如“bin \ Debug \ Projectname.XML”。

现在如果你在另一个解决方案中使用你的dll,并且你已经为它创建了XML文档文件,那么Intellisense会为你的dll工作。

+0

两者的答案都是一样的,但你第一。 – user3800527

为了与智能感知功能使用XML注释,请按照下列步骤如下:

  1. 生成the .XML documentation为您的代码,右键单击该项目名称>属性>生成>输出,并检查选择“XML文档文件:” 确保.xml文件的文件名是一样的,你要支持并保存,然后构建此解决方案

  2. To use the generated .xml file for use with the IntelliSense feature大会,让.xml文件是我n个相同的目录装配,我复制这两个文件到另一个解决方案和测试此功能,并使用XML注释的智能感知正常工作如下:

enter image description here