Alex Rivera | Logout

How to use XML documentation files

Asked 2009-03-20T10:35:50.450
19

  1. When using an external assembly which comes with an XML documentation file, how do I get visual studio to find it?

  2. When having an XML documentation file, is there a program or xml transform file or something I can use to look at it in a nice way? Not necessarily as complex as the msdn documentation viewer thingy, but at least something nicer than the pure xml...

.net visual-studio-2008 xml-documentation
Edit
Report

1 Answer

1

1) The documentation file must have the same name as the assembly name, with the added extension '.xml', and reside in the same directory as its corresponding assembly. So for example, you have an 'MyCompany.MyNamespace.dll' and a 'MyCompany.MyNamespace.dll.xml' file in the same directory.

2) NDOC can generate some dirrent formats of documentation.

answered 2009-03-20T10:42:01.057

Your Answer