PP: Methods w/o any comments

1 Aug 2006 9:34 PM

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

1 Aug 2006 9:49 PM

Greg Young

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

<prabh***@hotmail.com> wrote in message
Show quote

news:1154468050.944880.98980@i42g2000cwa.googlegroups.com...
> 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
>