PP: Methods w/o any comments

  • Thread starter Thread starter prabhupr
  • Start date Start date
P

prabhupr

Hi Folks

We are using nDoc to generate CHM/HTML help files.

My requiremen : Is there an easy way (any tool) that generates list of
methods which has no documentation (<Summary> Comments) defined, so
that we can circulate this list to the team to ensure API Documentation
is complete.

Thanks
PP
 
When you build it will give you compiler warnings when generating XML
documentation that there is no documentation for the given method.

Warning 1 Missing XML comment for publicly visible type or member
'PerformanceTestHarness.TestHandler' C:\Documents and Settings\Greg\My
Documents\Visual Studio
2005\Projects\PerformanceTestHarness\PerformanceTestHarness\Program.cs 57 26
PerformanceTestHarness

Cheers,

Greg Young
MVP - C#
http://codebetter.com/blogs/gregyoung
 
Back
Top