Re: how to write a program documention

At the start of the code: ################### # Pgm Name: # Whatever else you want # $log :$ and other RCS info. ################### DEFINE ident CHAR(80) LET ident="rcs_version string" (This allows you to do a 'what' on the executable and determine what version of the source you are using) At the head of each function: #################################### # Input: # Ouput: # Process: # Calls: name of any called functions/procedures etc. #################################### Within each function, each code block should have some comment describing its function, hard to understand code should have comments associated with it as well. A daunting task for anyone to pick up. It si properly the responsibility of the programmer and should be gone over in a formal code review. Lots of luck. cheers j. At 09:47 PM 12/10/97 +0300, you wrote: > >Dear all > A have a set of module written in informix 4gl and it is required from me >to write a documention of each program in each module i.e program function, >tables used,procedures,etc.. >what is the best way to do this ? Is there any site to read about documentation >techniques? >regards >O.Osma > > >