C＃xml文档

Question

程序集附带的.xml文档文件（.dll文件）的用途是什么。

我知道，如何构建一个（as here, for example），但它们可以用于什么？

此外，如果可以将此文档集成到MS Visual Studio环境中，应该如何完成？

Answer 1

如果将XML文件放在与DLL相同的文件夹中，Visual Studio将在IntelliSense中显示说明。 （包括参数工具提示）

Answer 2

将xml文档与推荐的标记一起使用可以极大地提高代码在外部类使用时的可读性。

此外，您可以使用Sandcastle等工具从xml注释生成帮助文档。此工具生成的chm文件与您在msdn for .NET类中看到的文档非常相似。

至于与Visual Studio环境的集成，它会自动完成，并在您构建项目时立即执行。使用记录的类/方法/属性时，Intellisense功能会显示xml注释。

此外，像Ghost Doc这样的免费Visual Studio工具（来自SubMain）允许您只使用键盘快捷键生成大多数标签！