如何使用XML文档文件

Question

1. 当使用带有XML文档文件的外部程序集时，我如何让Visual Studio找到它？

2. 当有一个XML文档文件时，是否有一个程序或XML转换文件之类的工具可以以更好的方式查看它？不一定像MSDN文档查看器那么复杂，但至少比纯XML格式更好看...

- Svish

Answer 1

1：你只需要将它放在与dll相同的文件夹中即可。

2：它需要被持久化吗？对于“实时”使用，Visual Studio IDE和"Reflector"都允许您查看文档（针对类型/成员等）。有一些工具可以转换它，但我从未费心去尝试。 Sandcastle也值得一看，但它对我来说从未友好过;-p

- Marc Gravell

---

我尝试将它放在同一个文件夹中，但似乎无法成功获取它。我仍未获得文档。 - Svish

文件必须是Foo.Bar.dll和Foo.Bar.xml（例如）；您确定您正在从该位置引用dll吗？而且您确定它是一个注释文件吗？ - Marc Gravell

似乎我必须重新启动VS才能让它工作……是否有一个命令来重建/重新阅读文档或其他什么东西呢？ - Svish

Answer 2

关于第二点：您应该能够使用对象浏览器（查看>对象浏览器（Ctrl W + J））查看文档的“漂亮版本”，然后浏览到要查看文档的类。我使用对象浏览器来查看自己的文档，因为它比xml文件或注释更易于阅读。

- Emil G

Answer 3

回答你的第一个问题：XML 文件应该与程序集同名并且放在同一个目录下。例如，如果你有一个名为 Svish.dll 的程序集，则文档文件应该命名为 Svish.xml 并放置在相同的目录中。

- Gerrie Schenck

Answer 4

1) 文档文件必须与程序集名称相同，并添加扩展名“.xml”，并位于相应程序集的同一目录中。例如，您有一个“MyCompany.MyNamespace.dll”文件和一个“MyCompany.MyNamespace.dll.xml”文件在同一个目录中。

2) NDOC可以生成一些不同格式的文档。

- Razzie

---

在我看过的例子中，也适用于我的情况，就像Marc Gravell的回答一样。也就是说：MyCompany.MyNamespace.xml而不是MyCompany.MyNamespace.dll.xml。 - Stéphane Gourichon