RE: Document informix sql/4gl

From: Watson Paul <Paul.Watson@fefc.ac.uk> > > > 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. Or, to put it succintly: # # If its hard to code # then it should be # impossible to use # ??? _________________________________________________________________________ Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com. Share information about yourself, create your own public profile at http://profiles.msn.com.