Change history in code comments considered harmful

I really dislike seeing code comments that say

// Changed by X on date Y for bug Z start
...
// Changed by X on date Y for bug Z end

That is what revision control is for. Use commit messages that describe the reason for the change and generally make commits that change only one thing at a time. That’s my preference over change history in code comments.

This entry was posted in Programming and tagged . Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>