Does you or your team have any comment standards when it comes to checking in source?
We've always commented as we like
Reason I ask:
I was asked whether we can tell if the source changed as a result of a bug fix, or change. i.e if someone asked when was a certain bug fixed I could give them the revision, person, date and what was/wasn’t included.
I was asked if there would be any value in implementing some comment standards and I couldn’t argue the case against. If the first line indicated “BUG: Ticket: 65748” we could instantly tie the work back to a logged ticket.
It would make reviewing comments easier too since all would be of similar format. The small overhead os obviously when checking in source.
I try to keep my check ins small, and use the message to describe what I just did and why. If your working on a ticket, including the ticket Id is a good idea. Having your bug tracker hooked up to your VCS with some kind of convention for comments is also a good idea. Say having something like: “Closes #1234” that automatically sets the ticket to closed and associates the check-in what commit is invaluable.
Do you use Reshaper? It has a Todo lsit functionlity that allows you define regexp to track and list comments. So you can set it to track and list things like: // BUG: // HACK: //TODO: etc.
Think there may have been some misunderstanding. DHTMLGOD seems to have understood though. I was talkign specifically about comments when checking in code, not inline comments.
After creating the thread I did start reading about SubVersion and the possibilities that exist. Seen that tortoise can integrate an issue tracker. At it’s simplest it can store a bug (ticket) id, after setting some properties on the repo. This at least lets check-ins be associated if required to an issue. Even provides a link to the issue tracker.
Further reading led me to gurtle and other plugins that allow issue tracker integration. i.e search and select. I presume also as you mention “closing of tickets too automatically”. I may look into this although it would require me to build one to work with our issue tracker.
Dhtmlgod, no I have never used ReSharper, but I have heard of it in this forum. If I am coding in Dreamweaver, I use their built in functions. Haven’t been coding as long in .NET as you probably have. but I will defiently give it a look now. I’m sure it will be supported in VS2010…