Code maintenance: To add comments in code or to just leave it to the version control?
Posted
by
Chillax
on Programmers
See other posts from Programmers
or by Chillax
Published on 2012-11-09T18:32:25Z
Indexed on
2012/11/09
23:23 UTC
Read the original article
Hit count: 245
We have been asked to add comments with start tags, end tags, description, solution etc for each change that we make to the code as part of fixing a bug / implementing a CR.
My concern is, does this provide any added value? As it is, we have all the details in the Version control history, which will help us to track each and every change?
But my leads are insisting on having the comments as a "good" programming practice. One of their argument is when a CR has to be de-scoped/changed, it would be cumbersome if comments are not there.
Considering that the changes would be largely in between code, would it really help to add comments for each and every change we make? Shouldn't we leave it to the version control?
© Programmers or respective owner