msgbartop
News, views, tips and tricks on Oracle and other fun stuff
msgbarbottom

Code Comments Gone Wrong

Dimitrios Kalogirou offers good advice:

Write self descriptive code ! Your code should be read like sentences. Avoid smart shortcuts and tricks because they break the reading… I use code comments when the code is not really self documenting. Comments should convey what code cannot. They should explain the reasons for a specific design decision, they should explain what code is supposed to achieve and why.

Filed in Tips on 19 May 12 | Tags:


Comments are closed.