PDA

View Full Version : Coders - Revision history in boilerplate?



jhonan
May 25th, 2011, 11:08 AM
A random question for anyone maintaining code in a source control system.

Do you usually put revision comments in the boilerplate / above the code block you're changing, OR do you leave revision comments out of the code altogether and put the comments in when you're submitting to CVS?

NovaAesa
May 25th, 2011, 12:54 PM
I place the revision comments in the comments section when I commit to the SVN repository.

jhonan
May 25th, 2011, 01:22 PM
I place the revision comments in the comments section when I commit to the SVN repository.
Yeah, that makes sense. I think we'll start using that method instead. Thanks!

jespdj
May 25th, 2011, 02:49 PM
On almost all projects that I've worked on in the past 10 years we never put revision comments in the source code itself; we just put those in the commit commtents of the version control system.

The software I develop is mostly Java.