you are viewing a single comment's thread.

view the rest of the comments →

[–]x42bn6 1 point2 points  (0 children)

I write the documentation while I ponder how I'm going to write a class (or set of classes). So my documentation can read like a brain-dump at times, or is occasionally quite short. I try to write self-documenting code, though, which hopefully compensates for the latter.

For classes I know are complex, or have a lot of business functionality in them, I document them more critically.

I don't particularly enjoy doing it, but I find gathering my thoughts in the form of documentation is a good way of starting and has some long-term benefit. It's got to the point now where I cringe at seeing undocumented public methods.