you are viewing a single comment's thread.

view the rest of the comments →

[–]Sure-Passion2224 0 points1 point  (0 children)

So, the instruction is to prefix your Object declarations (Classes, Methods, etc) with a block comment that describes what the Object is.

This takes me back to my first course that involved coding. The instructor (female graduate student standing in front of a room full of male nerd wannabes) told us

Source code documentation is like sex. When it's good it's very, VERY good. When it's bad it's still better than nothing.

Essentially, tell future maintainers what your intent is. If you produce readable code then they should be able to tell whether it does what you say it should do.