Comments on: Commenting code http://www.krishnashasankar.com/2008/12/commenting-code/ Thoughts on php, photography, travel and technology Mon, 16 Aug 2010 07:30:48 +0000 http://wordpress.org/?v=2.9.1 hourly 1 By: Krishna http://www.krishnashasankar.com/2008/12/commenting-code/comment-page-1/#comment-80 Krishna Sat, 20 Dec 2008 06:21:50 +0000 http://www.krishnashasankar.com/?p=212#comment-80 Few days ago, someone spoke to me about having the following comment format on code. The person was just suggesting. This means no harm to his innocence, just that it was too funny for me.. Read this, In every piece code, above each edit <code>// [DATE:TIME] {why not timezone?} | [Person Edited] | [Reason for edit] | [Other Effects]</code> I wish i could have said "then why on earth do we need subversion and issue tracking, we could might as well junk the system with 2 million lines of code(1.8 million of them being comments) ha ha.. " The problem of commenting code is inherent to the system, its that when a developer comments the code , they tend to feel that his or her part is done; they tend to ignore he best practices in naming conventions and instead use comments as work around for it. Programs should be like classical poems, not like maths answer sheets with scribblings and corrections everywhere, that is why you call them a programming language... :) Few days ago, someone spoke to me about having the following comment format on code. The person was just suggesting. This means no harm to his innocence, just that it was too funny for me..

Read this,

In every piece code, above each edit

// [DATE:TIME] {why not timezone?} | [Person Edited] | [Reason for edit] | [Other Effects]

I wish i could have said “then why on earth do we need subversion and issue tracking, we could might as well junk the system with 2 million lines of code(1.8 million of them being comments) ha ha.. ”

The problem of commenting code is inherent to the system, its that when a developer comments the code , they tend to feel that his or her part is done; they tend to ignore he best practices in naming conventions and instead use comments as work around for it.

Programs should be like classical poems, not like maths answer sheets with scribblings and corrections everywhere, that is why you call them a programming language… :)

]]>