RE: Document informix sql/4gl

> From: Ronald Cole <ronald@forte-intl.com> > > > >"mark biron" <markb99@mediaone.net> writes: > > > Is there any software to help document informix 4gl ,sql. > and perform > > > screens? > > > We have many 4gl/sql and perforrm screen source code and > litter time. > > > >Why is putting your comments in the screen source code inadequate? > > What's a "comment"? These are misleading and totally false statements embedded in to code to ensure that nobody knows how it works or to give a false impression of what is happening. There are a number of rules 1. Lie in the comments. You don't have to actively lie, just fail to keep comments as up to date with the code. 2. Pepper the code with comments like /* add 1 to i */ however, never document woolly stuff like the overall purpose of the package or method. 3. Never never put a comment on a variable. Facts about how the variable is used, its bounds, its legal values, its implied/displayed number of decimal points, its units of measure, its display format, its data entry rules (e.g. total fill, must enter), when its value can be trusted etc. should be gleaned from the procedural code. Paul Watson # WF Software Ltd # If its hard to code Tel: +44 1436 674729 # then it should be Fax: +44 1436 678693 # impossible to use www.wfsoftware.com # ********************************************************************** The contents of this e-mail are confidential to the ordinary user(S) of the mail address(es) to which it was sent and may be legally privileged. If you are not the intended recipient, any disclosure, copying, distribution or use of it, or any part of it, in any form whatsoever, and any actions taken or omitted to be taken in reliance on it, is prohibited and may be unlawful. **********************************************************************