David I have an auto-doc style of comment that defines what the program does, and version stamps that are compiled into the object code that include a short description alongside other information, similar to the Windows version resource.
But I would suggest that modification logs really belong outside the source code and should be in your source code control system (e.g. subversion). That way, you can match the modification log with fetching the actual versions of the source code as it was at that point, and use the tools provided (e.g. TortoiseSVN) to do visual diffs across versions if you need to see what changed. Regards Brian > > -----Original Message----- > From: u2-users-boun...@listserver.u2ug.org > [mailto:u2-users-boun...@listserver.u2ug.org] On Behalf Of > David A. Green > Sent: 26 June 2009 17:50 > To: 'U2 Users List' > Subject: [U2] Program Comments/Documentation/Notes/Revision History > > I've always commented my program at the beginning, but some > programs have many changes and when we have 300+ lines of > comments it gets a little tedious to deal with embedded in > the source code. > > > > I'm think of placing them in an external file and then doing > a $INSERT in the source code in order to tie them together. > > > > How do you handle the long comments? > > > > Thanks, > > David A. Green > > www.dagconsulting.com > > (480) 813-1725 > > > > _______________________________________________ > U2-Users mailing list > U2-Users@listserver.u2ug.org > http://listserver.u2ug.org/mailman/listinfo/u2-users > > _______________________________________________ > U2-Users mailing list > U2-Users@listserver.u2ug.org > http://listserver.u2ug.org/mailman/listinfo/u2-users > _______________________________________________ U2-Users mailing list U2-Users@listserver.u2ug.org http://listserver.u2ug.org/mailman/listinfo/u2-users
