Re: Documenting code changes

[Vernon Hamberg <vhamberg@xxxxxxxxxxxxxxx>]

Hi Cyndi

If you are using RDi, you can filter out any comments when working - so 
it wouldn't matter if they are there a long time. Well, not as much, maybe!

As to using the first 5 positions, that's a choice - I currently put a 
pair of start and end comments around changes.

An issue with using the 1st 5 is that it can show only the most recent 
change at any particular location.

Vern

On 9/27/2013 10:54 AM, Cyndi Bradberry wrote:
> Hi,
> In the past, we have documented at the top of the program the date, ticket # and a description of a change. Now we are being told to put the ticket number in the first 5 positions, copy the line we are changing, commenting out the original line and editing the new. In CLP, /* */ to enclose the ticket number on the line being changed.
>
> But I cannot get anyone to explain how long this remains in the code. I don't have a problem with commenting out and entering new lines, but when I go in to maintain the program next, I generally want to clean up (delete) the unused lines of code to make for better readability.  When making large changes, I also make backup copies of the source member just in case I have to go backwards.
>
> Can anyone point me to a best practices for documenting code changes ? This would have to cover RPG IV and Free and CL programs. We are working towards a SOC 2 Type 1 compliance.
>
> TIA,
> Cyndi B.
> Boise, ID