Clever Geek Handbook

How do I create class documentation from a .NET DLL?

I have a proprietary .NET DLL with no source code that I need to use. How can I create documentation about classes exposed by DLLs?

I would be looking for something like javadoc

for java.

+3


source to share


2 answers


Use Microsoft Sandcastle , possibly in conjunction with Sandbule Help File Builder . It will generate HTML documentation files or Windows help files.



If the DLL is accompanied by an Xml file of the same name, that file may even contain some textual DLL documentation. Otherwise Sandcastle can still be useful because it will generate an overview of the classes and their members, where you can navigate from type to type by clicking links.

+2


source


A note on the Sandcastle home page at CodePlex:

The Sandcastle CodePlex project is no longer under active development by Microsoft and thus there will be no future releases on this site.

The existing Sandcastle source code has been hacked into the Eco Woodruffs Sandcastle Help File Builder site at http://shfb.codeplex.com/ (Moved to → GitHub ). This is the new location where you have to go from that point forward to download the latest version. Eric will be responsible for the new Sandcastle releases from here.



More comment on @ORMapper's comment, but I can't comment (shy of the 50 rep required).

+2


source






More articles:


All Articles