Documenting a class is not all that useful in most cases. It makes more
sense to document the functionality which sits in methods.
I personally try to document everything although I use a more formal
approach with Help Builder (
www.west-wind.com/wwhelp/) into which I import
the Xml documentation and then usually further document it there.
It all depends on who the docs are for, but generally the more the merrier
<g>.
+++ Rick ---
--
Rick Strahl
West Wind Technologies
http://www.west-wind.com/ http://www.west-wind.com/weblog/
----------------------------------
Making waves on the Web
"C# Learner" <cs****@learner.here> wrote in message
news:um**************@tk2msftngp13.phx.gbl...
What are your views on XML documentation comments?
I always comment every class using <summary> tags, and comment *some*
methods. A lot of C# code that I've seen written by others uses
appropriate XML documentation comments for *every* method.
What do you think about this? Should _every_ method (including private
ones, for example) be commented?