Re: commenting sub procedures -- RPG400-L

× 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.

Screw documentation... Make the procedure self explanatory.

On Fri, Mar 23, 2012 at 8:14 AM, Vern Hamberg <vhamberg@xxxxxxxxxxx> wrote:

Hi Dave

I would put them in both the prototype AND the procedure. Prototypes are
often collected in a single /include member - you need the comments
there, too.

This is what the wizard in RDP does - it creates a comment header on
both. I find that useful myself.

Vern

On 3/23/2012 3:13 AM, Dave wrote:

Hi,

Where do you all put your comments on your sub-procedures? In the
prototype, or in the procedure itself? Ours have always been in the
prototype, which I have never liked as they are too far away from the
code. We haven't yet got V7.1 but given that the internal procedure
prototypes become unnecessary, it seems like comments should not be
placed in the prototype.

--
This is the RPG programming on the IBM i / System i (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 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.