News for hackers. Stuff that matters.

A comment on Coding Without Comments.

Re:Coding Without Comments by greyman on Friday July 25, 2008 @08:02AM (#256511)
While it is true that when some idea can be expressed by descriptive variable or function name, comment is not necessary.

But there are many places in the code, where it is highly desirable to explain by plain words, why certain solution was adopted, that certain part is a bug fix, or why some part of the code is counter-intuitive. I for one am much more happier when my colleagues comment their code extensively.

To look at it from the opposite side: Is there any inherent problem with having too much comments? (provided they are correct).

[ Parent | on HN ]
Re:Coding Without Comments by stcredzero on Friday July 25, 2008 @11:20AM (#256703)
If you can't write intention revealing code, this often is a symptom! Most often this means that there are implicit rules written into your code base. 90% of the time or more these should be factored out!

Also, another problem with too many comments: this is more stuff to maintain. Chances are, the programmer already has enough to do!

[ Parent | on HN ]