|
I have usually used comments in the opposite way. That is, I put in the comments first as a sort of outline for what needs to be done. then when I fill in the code around it, my documentation is done. the trick is when I changes the outline, to remember to change the earlier comments. :>) just another way, Dave B >>> RPower@xxxxxxxxxx 08/16/2004 8:56:54 AM >>> Hehe yeah I'm 29 yrs old now. Started this when I was 23. I try to make sure that complex code is documented. Around here, if you don't, they'll chop off your fingers which is a nice touch. I'll usually document about 30% as much as I code. If the documentation ends up looking like *Chain to file to get record -> I usually leave stuff like that out because you can see it in the code. But if it's more complex like a calculation of rates based on steps, I'll usually try to get the point across in plain English with a written example as to how the input and output should like, just in case someone reads it in the future and tries to figure out just what I'm doing. Usually, I'll write the whole program (new stuff) with very little documentation, then once it's all done and tested, I'll go back thru the source and start reading each line to see whether or not it needs to be documented. Then we have an on-line database that's updated with any changes made to the program. I also make sure that I list each and every indicator used in the program so that you don't have to guess if it's used or not. Whether or not my colleagues keep that up to date is another story lol. I've heard the phrase "just compile it and it'll tell you the indicators used" but to me that's a couple minutes I could have saved so I could read my RPG List email :) <vbg> Ron Power Programmer Information Services City Of St. John's, NL P.O. Box 908 St. John's, NL A1C 5M2 Tel: 709-576-8132 Email: rpower@xxxxxxxxxx Website: http://www.stjohns.ca/ ___________________________________________________________________________ Success is going from failure to failure without a loss of enthusiasm. - Sir Winston Churchill "Dan Bale" <dbale@xxxxxxxxxxxxx> Sent by: rpg400-l-bounces@xxxxxxxxxxxx 16/08/2004 11:14 AM Please respond to RPG programming on the AS400 / iSeries <rpg400-l@xxxxxxxxxxxx> To "RPG programming on the AS400 / iSeries" <rpg400-l@xxxxxxxxxxxx> cc Subject RE: Hi New to list. QCMDEXC Question Kind of long. Thanks a lot. > -----Original Message----- > From: rpg400-l-bounces@xxxxxxxxxxxx / RPower@xxxxxxxxxx > Sent: Monday, August 16, 2004 9:34 AM > > Welcome to the list Matthew. I too went to a school that specialized in > using RPG for their programming training. Mind you that was 5 years ago. You are *so* old, Ron! <geezer grunt> > Keyin College here in Newfoundland Canada. Although I learned a lot more > once out in the workplace. Including debugging code that was not mine. > That's really fun (sarcastic note inserted). One thing in school they > tell you is to document, document, document. Must have been a new idea > when I was there cause not many programs I started working on had > documentation lol. So, everything you work on, you document? Do they let you do this during your normal working hours? The mind boggles. db -- This is the RPG programming on the AS400 / iSeries (RPG400-L) mailing list To post a message email: RPG400-L@xxxxxxxxxxxx To subscribe, unsubscribe, or change list options, visit: http://lists.midrange.com/mailman/listinfo/rpg400-l or email: RPG400-L-request@xxxxxxxxxxxx Before posting, please take a moment to review the archives at http://archive.midrange.com/rpg400-l. This OutBound email has been scanned for Viruses -- This is the RPG programming on the AS400 / iSeries (RPG400-L) mailing list To post a message email: RPG400-L@xxxxxxxxxxxx To subscribe, unsubscribe, or change list options, visit: http://lists.midrange.com/mailman/listinfo/rpg400-l or email: RPG400-L-request@xxxxxxxxxxxx Before posting, please take a moment to review the archives at http://archive.midrange.com/rpg400-l.
As an Amazon Associate we earn from qualifying purchases.
This mailing list archive is Copyright 1997-2024 by midrange.com and David Gibbs as a compilation work. Use of the archive is restricted to research of a business or technical nature. Any other uses are prohibited. Full details are available on our policy page. If you have questions about this, please contact [javascript protected email address].
Operating expenses for this site are earned using the Amazon Associate program and Google Adsense.