|
I usually find that if I stick to three rules, it works pretty well. They are:
/*1) If it isn't clear enough to me at the time of the writing to explain in 3 line comments, I'd better look around some more because I'm being DUMB!
2) Make sure that all your variables, structures, classes and functions are explanatory in their own names and code.
3) Switch rule 1's and 2's priority and check it again, document anything that doesn't look right and let some one else read it to see if they understand it.
If I get by those the first time, a miracle has occurred ;-)*/
|