C#xml文档

Question

.xml程序集(.dll文件)附带的文档文件的用途是什么.

我知道,如何构建一个(例如,这里),但它们可以用于什么？

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

Answer 1

如果将XML文件放在与DLL相同的文件夹中,Visual Studio将在IntelliSense中显示说明.(包括参数工具提示)

Answer 2

将XML文档与推荐的标签一起使用时，可以大大提高外部类使用代码时的可读性。

另外，您可以使用Sandcastle之类的工具根据xml注释生成帮助文档。此工具会生成一个chm文件，该文件与您在msdn.net类上看到的文档非常相似。

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

此外，免费的Visual Studio工具（如Subhost的Ghost Doc）（使您可以使用键盘快捷键即可生成大多数标签）！