I agree and in general it looks messy as if someone is marking their
territory. The exceptions I would think would be:
1. Temporary code that will soon be cleaned up and the comments
removed. This includes sort term hacks that have a short lifespan (less
then 1 release). (I have done this)
2. If the code/bug fix is complex and takes a huge amount of comments
and an email thread to understand its meaning. This should be very rare
and the code should be looked at to make it simpler. This should only
have a bug number and not their name.
-Bryan
On 03/26/2010 11:27 AM, John Plevyak wrote:
There are a number of places in the code where
folks have made a change and surrounded the change
with comments with their name and perhaps some bug
number.
I was wondering what folks think of this? I think
it makes the code look messy and unprofessional, as
if it is some historical artifact being tinkered around
with by folks who don't really feel like it is theirs.
It also seems to be an excuse to ignore the surrounding
coding and naming conventions and to generally treat
the change a patch (in the sense of a something glued on)
rather than a modification which results in a new (better)
product.
I don't mind if the bug is very obscure and there is
a comment block which describes a non-obvious aspect
of the implementation the lack of understanding of which
triggered the bug. In other words if the bug # is just
an aside to a descriptive comment block.
Thoughts?
john
