Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Extract xml comments for public members only

Tags:

I'm using xml comments to document public as well as internal and private members of my components. I would like to package the generated documentation xml files with component assemblies in order to enable "rich" (e.g. with method, exceptions and parameter descriptions) Visual Studio Intellisense with the end product. The problem with it is that the C# compiler creates documentation entries for everything (including internal classes, methods, private fields of internal enums etc.) and there seems to be no switch to "only public members" mode.

Now I don't want to go over 50 files with XX methods in each and remove all comments for private and internal members. Even if I did that, I probably would not have much success with auto-gen'd resource files, because these strongly-typed resource classes are automatically commented and non-public.

My question is: is there some option/flag that I'm overlooking? If no, are there some tools that could help separate public members from the rest (before I start to code one)?

like image 683
liggett78 Avatar asked Mar 08 '09 22:03

liggett78


2 Answers

SandCastle Help File Builder has an option to recreate the xml files containing only the configured access modes for methods, properties, etc...

The only "downside" is that you'll have to generate a documentation.

EDIT

Since it's been a long time ago I forgot that I added a "component" to SHFB to generate the XML.

The good news is that this component is included in SHFB.

You have to add the "Intellisense Component" to the SHFB project. It will then generate the XML according to the configured SHFB project.

For more info: Intellisense Component in SHFB

like image 74
Stécy Avatar answered Sep 30 '22 05:09

Stécy


There is a tool inside the eazfuscator that can remove non-public documentation. You can see an example here

like image 25
adrianm Avatar answered Sep 30 '22 06:09

adrianm