PP: Methods w/o any comments

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

prabhupr@hotmail.com - 01 Aug 2006 22:34 GMT

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

Reply to this Message

Greg Young - 01 Aug 2006 22:49 GMT

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

> Hi Folks
>
[quoted text clipped - 7 lines]
> Thanks
> PP

Reply to this Message

Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...