On 03/26/2010 12:27 PM, John Plevyak wrote:
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.
I think at a minimum we should eliminate all non-Jira bug number references and comments. They are completely pointless, we have no way of finding that information.
For the rest, I agree that we shouldn't litter the code with such comments. In fact, I don't even know if it's useful to have any Jira bug references in the code at all. Since we require that all commits are associated with a Jira ticket (I hope everyone is on board with that still), it's pretty easy to use "svn blame" for example to get a reference from the code to which Jira ticket is associated with that commit. That should be enough as a cross reference IMO.
In the future, a useful tool could be to augment "svn blame" to also find the associated Jira ticket # :-).
So, in conclusion, my +1 would be to eliminate all "bug # comments" from the code entirely, with the caveat that we continue to require a Jira ticket with every commit (and as mentioned before, it's OK to use the one ticket for multiple commits).
Cheers, -- leif
