× The internal search function is temporarily non-functional. The current search engine is no longer viable and we are researching alternatives.
As a stop gap measure, we are using Google's custom search engine service.
If you know of an easy to use, open source, search engine ... please contact support@midrange.com.



> -----Original Message-----
> From: rpg400-l-bounces@xxxxxxxxxxxx / RPower@xxxxxxxxxx
> Sent: Monday, August 16, 2004 9:57 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.  <snip>

Generally speaking, and IMO, I don't like to see documentation interrupting
the flow of code.  If some code needs to be documented, the code should be
in a subroutine / subprocedure / service program, and that needs to be
documented.

> 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 :)

Indicators?  You use indicators?

Well, yes, of course, just not numbered indicators, right?  Unless they're
display or printer file related?  I like to use named indicators when they
can be used in conjunction with If, When, Dox, and it can be read in
English-like terms.

 d Customer#IsValid...
 d                 s               n
 c     Key           Chain     CusMas
 c                   Eval      Customer#IsValid = %found(CusMas)
..........
 c                   If        Customer#IsValid

Sure beats the heck out of "If  *in25" and it's self-documenting.  Some may
prefer just using the %found(CusMas) as the "indicator".

db


As an Amazon Associate we earn from qualifying purchases.

This thread ...

Follow-Ups:
Replies:

Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

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.