A documentation question

[web1110]

Hi y'all,

Generally speaking, comments beginnng with /// are destined for help files
and those that begin with // are just inserted comments. I surmise that
problems would arise in help file generation if all comments begin with ///.

This is ok, if true. Unfortunately, where I have a lot of // code comments,
I cannot minimize them unless I surround them with a region, not something
that is practical. This is something I would like to be able to do, but
alas...

Are there any opinions on the bast way to document code?

Thanx,
Bill

[web1110]

Perhaps a better way to state this is:

What is the differences between /// and // and how should they be employed.

Thanx,
Bill

[Floyd Burger]

Bill,
I've always used /// to document methods and properties for the outside
reader, someone who is going to use the methods or properties. I use // to
document code in-line, something that will help someone (including me) to
understand why I did something a particular way.

--
floyd
"web1110" <we***@comcast.net> wrote in message
news:cZ********************@comcast.com...

Perhaps a better way to state this is:

What is the differences between /// and // and how should they be
employed.

Thanx,
Bill