Hi guys,
Do you know of a good style guide about coding? Particularly about how to comment code?
In the last years I've seen the way you code and the naming conventions you use are very influenced by the language you use. Is that applicable for comments?
I know there's not a unique way of doing things and, after all, comments are ignored by the compiler but I was wondering what's your two cents on this.
I sort of like the javadoc style but is not always the most readable thing. Also, what happens with those smaller comments?
E.g.: (what do you prefer? idents? Spaces? All together despite is less readable?)
// Colors affected by XX
AA
BB
// Colors affected by YY
CC
DD
// Colors affected by XX
AA
BB
// Colors affected by YY
CC
DD
// Colors affected by XX
AA
BB
// Colors affected by YY
CC
DD
I'll tick this question as Community Wiki.