Alex Rivera | Logout

Is there an API in .net to read XML comment documentation file

Asked 2009-04-22T02:37:25.890
18

In this question I see that Microsoft ships the XML documentation files for the BCL. I wonder if anyone knows if there an API within .net that can be used to look this up at runtime. I know we can parse the files manually using the XML API.

The use case is that we allow custom (read 3rd party) types/assemblies to be used in our system, and when selecting these in the UI, we'd like to extract the documentation as specified by the custom type/assembly creator or if not available provide other defaults.

Edit
Report

2 Answers

4

Microsoft's Sandcastle is a tool for extracting documentation from assemblies with or without the help of the XML comment files. It has been released as open source. You can try taking a look at the code of that tool.

answered 2009-04-22T04:14:18.450
1

You might want to investigate the following libraries

answered 2009-05-02T16:10:28.943

Your Answer