I always tell my Indians: Write all comments and code with an eye to them getting read in two years by a man you've never met who does not speak your language, has never heard of this project before, and needs to fix the bug that brought down the server in less than 2 hours or the boss will have his hindquarters. Because that is EXACTLY who will be reading this next.
Compliance with this direction is... sporadic.
/ implement first business logic */
public void process() {
...
}
Comments
I always tell my Indians: Write all comments and code with an eye to them getting read in two years by a man you've never met who does not speak your language, has never heard of this project before, and needs to fix the bug that brought down the server in less than 2 hours or the boss will have his hindquarters. Because that is EXACTLY who will be reading this next.
Compliance with this direction is... sporadic.
/ implement first business logic */ public void process() { ... }
Do the needful and reply to me the same.
the variation on that is "a psychopath with a chainsaw will maintain this code. he knows where you live."
then you do pop quiz-style code reviews. let someone's code get reviewed by his peers.