I think that the argument is not the amount of comments, 200 lines of
explanations is fine by me also, but where these are stored. When stored as
metadata, and not in the actual source code, it is easy to see which
comments relate to which version of the element and it also makes merge
operations a lot more straight forward.
Roy Chapman
External Consultant
Robert Bosch GmbH * (00 49) 0711/811-31795 / GSM (00 49)
0173/4887139
K5/ESQ * (00 49) 0711/811-31800
Postfach 20 02 40 * mailto:roy.chapman@de.bosch.com
D-70442 Stuttgart
> ----------
> Von: Marilyn Sander[SMTP:marilyn@hal.com
> Antwort an: Marilyn Sander
> Gesendet: Montag, 10. Januar 2000 19:58
> An: cciug@Rational.Com; cciug@abs-consulting.com
> Betreff: Re: [cciug] Writing the comment in the source file
>
>
> But what's wrong with 200 lines of comments to document 25 lines
> of changes? When I used to maintain code, I certainly appreciated
> my "wordy" predecessors who explained what they were doing to the
> code and why. We should remember that the source control system
> exists as an aid to good engineering, not as an end in itself.
>
> --Marilyn Sander
>
> | X-Sender: abs_info@mail.mindspring.com
> | Date: Mon, 10 Jan 2000 10:15:34 -0500
> | To: "jangareddi, ramesh" <jangareddi_ramesh@emc.com>, "'cciug'"
> <cciug@Rational.Com>
> | From: "A Better Solution, Inc." <cciug@abs-consulting.com>
> | Subject: Re: [cciug] Writing the comment in the source file
> | Mime-Version: 1.0
> | X-Majordomo-Taboo: cciug
> |
> |
> | Jangareddi,
> |
> | I could do so and will if after this you still request it., but I feel
> | obligate to first talk you out of it...
> |
> | the checkin in comment is always available as metadata to you and easy
> to
> | view, but when you place checkin comments in the
> | code then you end up with large source files as some small files change
> | alot and some engineers are very "wordy".... imagine a often changed
> file
> | that has after a year of development 200 lines of comments at the top
> | commenting 25 lines of often changed code.. I have seen it...
> | You could limit the comment string , but that only slows the problem
> | down... You could only place in the last comment, but then a cleartool
> | describe on the file would be equivalent to this..
> |
> | It is possible that you have some really good reason to do this....
> perhaps
> | it was just mandated down to you from higher management, but again I
> must
> | stress that perhaps this is not what you "really" want to do ... If I am
>
> | wrong, or my cautions do not apply to your particular situation, then of
>
> | course I will share a trigger that performs this action.... (or very
> similar)..
> |
> | http://www.abs-consulting/abs_consulting_triggers.html
> |
> | has a trigger called MAKE_VERSION_ID.tgr ... it creates static data in
> | source code... you could change is very easily to do what your asking..
> I
> | believe you could find the 2 lines that might need to change..
> | -
> | Hope this helps
> | -Charles
> |
> | --- VOB Corleone
> | "One day.. and this day may never come... I might ask you for a
> favor.."
> |
> | A Better Solution, Inc.
> | ----------------------------------------------------
> | Charles Clarke III ClearCase Consultant
> | A Better Solution, Inc. (770) 252-1500 x22 [phone]
> | 50 Springridge Ct.
> | Newnan, Ga. 30265 (770) 252-1501 [fax]
> | Email:
> | charles@abs-consulting.com
> |
> http://www.abs-consulting.com
> |
> |
> |
> | At 08:39 AM 1/10/00 -0500, jangareddi, ramesh wrote:
> |
> | >Hi cciug,
> | >
> | > I am looking for a way to write the ClearCase comment into the
> top
> | >of a source file, so if there is any trigger / method that some one is
> | >already implemented that would like to share, will be very helpful.
> | >
> | >Thanks a lot,
> | > - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
> | >
> | >
> | >
> | > http://clearcase.rational.com/cciug/mailing_list.html
> |
> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
> |
> |
> |
> | http://clearcase.rational.com/cciug/mailing_list.html
>
> -----------------------------------------------------------------------
> Marilyn E. Sander, CM Engineer marilyn@hal.com
> Fujitsu System Technologies (408)341-5590
> Division of HAL Computer Systems, 1315 Dell Avenue, Campbell, CA 95008
> -----------------------------------------------------------------------
>
> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
>
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
This archive was generated by hypermail 2b29 : Sun May 06 2001 - 00:22:23 EDT