How to use XML documentation files

.net visual-studio-2008 xml-documentation
Svish picture Svish · Mar 20, 2009 · Viewed 10.3k times · Source

  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...

Answer

Marc Gravell picture Marc Gravell · Mar 20, 2009

1: you simply drop it in the same folder as the dll

2: does it need to be persisted? For "live" use, both the VS IDE and "reflector" allow you to review the documentation (against the types/members/etc). There are tools to transform it, but I've never bothered. Sandcastle may be worth a look, but it was never nice to me ;-p

Related questions

Metadata file '.dll' could not be found

I am working on a WPF, C# 3.0 project, and I get this error: Error 1 Metadata file 'WORK=- \Tools\VersionManagementSystem\BusinessLogicLayer\bin\Debug \BusinessLogicLayer.dll' could not be found C:\-=WORK=- \Tools \VersionManagementSystem\VersionManagementSystem\CSC VersionManagementSystem This is …

Read More
How to set session timeout in web.config

I have tried very hard but cannot find a solution on how to set session timeout value for in-process session for an ASP.Net web application. I am using VSTS 2008 + .Net 3.5 + C#. Here is what I wrote by myself to …

Read More
The name 'ConfigurationManager' does not exist in the current context

I am trying to access connectionStrings from the config file. The code is ASP.NET + C#. I have added System.Configuration to reference and also mentioned with using. But still it wouldn't accept the assembly. I am using VSTS 2008. Any …

Read More