home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / rcf2102j.zip / rcf2.dsc < prev    next >
Text File  |  1997-03-31  |  3KB  |  73 lines
  1. Why REXX Code Formatter/2
  2. -------------------------
  3.  
  4. There are three important reasons why RCF/2 was developed:
  5.  
  6. (1) All programmers, novice or professional, develop a style of coding
  7.     that they like to use when writing a program.  Often times, however, 
  8.     in the haste to complete a program, or simply because they are 
  9.     concentrating on the logic and not the format, the style used is not
  10.     always consistent. For example, comments are not aligned alike for
  11.     easier reading and statements under a DO or SELECT are not properly
  12.     or consistently indented.
  13.  
  14. (2) Some programs are inherited and some contain code that was included
  15.     from another source.  In both cases, the style is often different, 
  16.     and in some instances, very different from that used by the person
  17.     maintaining the code.  A program with the END statement aligned with
  18.     the other code under a DO statement is very difficult to maintain by
  19.     a programmer used to having the END align with the DO statement,
  20.     itself.
  21.  
  22. (3) Finally, when a person has completed a program and wants to turn it
  23.     over to maintenance, give it to the customer for whom it was done, or
  24.     simply show to others, there is a natural desire, if not a need, to 
  25.     make it neat, consistent, and professional looking.  Even the best of
  26.     programs can look a bit sloppy if functions and REXX keywords are
  27.     sometimes in one case and sometimes in another.
  28.  
  29. Time does not always allow programmers to go back over their work to
  30. "clean" it up, and even when there is time, the task, by its nature, is a
  31. very boring one, and all inconsistencies are seldom removed.
  32.  
  33. The purpose of REXX Code Formatter/2 is to handle this formatting chore
  34. for the programmer.
  35.  
  36.  
  37. Features of REXX Code Formatter/2
  38. ---------------------------------
  39.  
  40. Using this product, users may, among other things:
  41.  
  42.    Define the indentation to be used in general plus the amount for: 
  43.     - Program statements subordinate to DO and SELECT,
  44.     - Statements that begin with THEN/ELSE, and 
  45.     - Continued statements.
  46.    Specify whether:
  47.     - Lines are to be split at semicolons,
  48.     - Redundant spaces are to be removed from program statements,
  49.     - New lines are to start before or after THEN/ELSE keywords, and
  50.     - END statements are to be indented to align with the corresponding 
  51.       DO/SELECT subordinate statements.
  52.    Specify the formatting for:
  53.     - REXX keyword Instructions,
  54.     - REXX keywords besides those that begin a REXX keyword instruction,
  55.     - Variables names,
  56.     - Function names, and
  57.     - Labels.
  58.    Define special formatting for selected function names.
  59.    Check for duplicate labels and insure all labels start on a new line.
  60.    Have RCF/2 create a file of label names as they appear in the program
  61.     so that all references to them in the program (and even other
  62.     programs) will reflect this same format.
  63.    Align full-line, left-hand, and right-hand comments.
  64.    Generate a listing of the formatted program.
  65.  
  66. In addition, while RCF/2 is not a syntax-checker or code debugger, it 
  67. does provide some assistance in program development.  It can, for example:
  68.  
  69.    Identify DO and SELECT instructions missing a corresponding END clause,
  70.    Flag comments that are started but not closed, and
  71.    Highlight literal strings with a missing quote.
  72.  
  73.