如何使用XML文档文件

时间:2009-03-20 10:35:50

标签: .net visual-studio-2008 xml-documentation

  1. 使用XML文档文件附带的外部程序集时,如何让visual studio找到它?

  2. 当有XML文档文件时,是否有一个程序或xml转换文件或者我可以用来以一种很好的方式查看它的东西?不一定像msdn文档查看器那样复杂,但至少比纯xml更好...

4 个答案:

答案 0 :(得分:16)

1:您只需将其放在与dll

相同的文件夹中即可

2:是否需要坚持?对于“实时”使用,VS IDE和“反射器”都允许您查看文档(针对类型/成员/等)。有改变它的工具,但我从来没有打扰过。 Sandcastle可能值得一看,但对我来说永远不会好看;-p

答案 1 :(得分:2)

关于2:你应该能够看到一个漂亮的版本"使用对象浏览器(视图>对象浏览器(Ctrl W + J))的文档,然后浏览到要查看文档的类的方法。我使用对象浏览器来查看我自己的文档,因为它比xml文件或注释更友好。

答案 2 :(得分:1)

回答第一个问题:xml应该与程序集同名,并且紧挨着它。因此,如果您有一个名为Svish.dll的程序集,那么您的文档文件应该是Svish.xml并且位于同一目录中。

答案 3 :(得分:1)

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

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