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.

Related articles:


© Eddie Awad's Blog, 2012. | Permalink | Add a comment | Topic: Tips | Tags:

By: [author-name]

This article was syndicated via RSS from: http://feedproxy.google.com/~r/EddieAwadsFeed/~3/KiK4FtwpTjk/code-comments-gone-wrong.html

No comments yet.

Leave a Comment

You must be logged in to post a comment.