RE: commenting sub procedures -- RPG400-L

Subject: RE: commenting sub procedures
From: "Monnier, Gary" <Gary.Monnier@xxxxxxxxx>
Date: Fri, 23 Mar 2012 23:29:34 +0000
List-archive: <http://archive.midrange.com/rpg400-l>
List-help: <mailto:rpg400-l-request@midrange.com?subject=help>
List-id: RPG programming on the IBM i / System i <rpg400-l.midrange.com>
List-post: <mailto:rpg400-l@midrange.com>
List-subscribe: <http://lists.midrange.com/mailman/listinfo/rpg400-l>, <mailto:rpg400-l-request@midrange.com?subject=subscribe>
List-unsubscribe: <http://lists.midrange.com/mailman/listinfo/rpg400-l>, <mailto:rpg400-l-request@midrange.com?subject=unsubscribe>

Rory,

By comparison, in many of those cases, the procedure itself will have minimal documentation, since any developer who has to maintain it should know what they're >doing before they start messing with the code.

FWIW this is a dangerous attitude, in my opinion anyway. It presumes someone thinks like you do and can understand your logic quickly. This may not be true. Comments in the code, even to the point of pseudo-code, can be of great benefit to those having to understand why you did something the way you did.

Gary Monnier

As an Amazon Associate we earn from qualifying purchases.

Follow-Ups:

Re: commenting sub procedures , Rory Hewitt

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.