I would agree with this in principle. Now I will tell you that I have (and still do) use this type of commenting. What we found we had to do at my last job with a software company was clean out in-line change comments that were more than two releases prior. When making large number of small changes in the code I would also indicate in the revision history that individual changes are not commented and not do the in-line comments.
I would agree that with a good source-code control program and/or procedure and the ability to do compares between versions you could successfully not comment the changes. Rich Taylor | Senior Programmer/Analyst| VERTIS 250 W. Pratt Street | Baltimore, MD 21201 P 410.361.8688 | F 410.528.0319 [EMAIL PROTECTED] | http://www.vertisinc.com Vertis is the premier provider of targeted advertising, media, and marketing services that drive consumers to marketers more effectively. "The more they complicate the plumbing the easier it is to stop up the drain" - Montgomery Scott NCC-1701 > -----Original Message----- > From: [EMAIL PROTECTED] [mailto:owner-u2- > [EMAIL PROTECTED] On Behalf Of Jeff Schasny > Sent: Wednesday, September 28, 2005 11:56 AM > To: [email protected] > Subject: RE: [U2] Good Programming Practice Question......... > > I've got to disagree with this one. This is the job of your source code > control system. I've seen applications which were commented in this manner > over a number of years and they are almost unreadable due to the sheer > volume of mod tags. > > -----Original Message----- > [mailto:[EMAIL PROTECTED] Behalf Of Marilyn Hilb > Sent: Wednesday, September 28, 2005 8:48 AM > To: [email protected] > Subject: RE: [U2] Good Programming Practice Question......... > > > Two items I have thought of. > > 1. In addition to putting a modification tag at the top of the code with > who/date/what, we also will assign a job number to the mod in addition to > a > No for the mod. Such as mod 01. Then throughout the code where the changes > are made we put a tag such as *<<01>> start and *<<01>> end or, just a > single tag at the end of the line if only one or two lines being changed. > This makes the changes very easy to search for and spot should there be > problems in the new code. > [snip] > ------- > u2-users mailing list > [email protected] > To unsubscribe please visit http://listserver.u2ug.org/ ------- u2-users mailing list [email protected] To unsubscribe please visit http://listserver.u2ug.org/
