Re: what is unclear about 01 02 03 -Reply

["Scott Swaim" <scott71@xxxxxxxx>]

That was my original point.  If you look at the comment that I added to the
code all that I did was to echo the code.  I do not know what this line of
code does.  I do not know what the fields are.  I do not know what the SR
means.  If the original code were commented,  I (you could substitue
"newbie", "junior programmer", "other poor sap" etc.) would not have had a
problem understanding the code.  But in the defense of the original poster,
this is only a snippet of code therefore we could ALL assume that the
comments were actually there but not copied into the post. <bg>

Also while we are on the subject of indicators,  Is there any update in the
works to DDS that will allow for named indicators?

One last thing that will make you go hmmmmmm!  After we remove left hand
indicators altogether from RPG will the Function keys be assigned new
labels?

           example   INKA = FK01


Scott Swaim
scott71@hpnc.com
Never wanting to incite an argument, just want to make you think.





-----Original Message-----
From: Hans Boldt <boldt@ca.ibm.com>
To: MIDRANGE-L@midrange.com <MIDRANGE-L@midrange.com>
Date: Wednesday, May 06, 1998 12:13 PM
Subject: Re: what is unclear about 01 02 03 -Reply


Scott:  While good comments are a requirement of any readable and
maintainable program, most modern coding guidelines recommend
against comments that just echo what the code already says.  The best
code is written in such a way that you don't need to read the comments
to understand what it does.  Techniques such as modularization and
meaningful variable and procedure names help to achieve readable
programs.

Having too many comments results in the following:
1) Comments can easily get out of synch with the code
2) It is not immediately clear which comments offer useful and
   meaningful insight into the logic.

Cheers!  Hans

Hans Boldt, ILE RPG Development, IBM Toronto Lab, boldt@ca.ibm.com







+---
| This is the Midrange System Mailing List!
| To submit a new message, send your mail to MIDRANGE-L@midrange.com.
| To unsubscribe from this list send email to MIDRANGE-L-UNSUB@midrange.com.
| Questions should be directed to the list owner/operator: david@midrange.com
+---