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
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Similar Threads

Using C# XML comments to document 4
Comments for dokumentation (VB.NET) 2
Calling all (any?) NDoc'ers 1
vb.net comments to developer documentation 2
Ndoc: tags inside the methods 11
pp 2k7 compatibility mode document locks up pp2k7 when trying toprint. 1
generating dev documentation from standard commenting. 5
Any Tool that generates MSDN Lib style help files from XML comment 1

Back
Top