home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Editor / DVD!FX17.LHA / FrexxEd / fpl / Comment.FPL.README < prev    next >
Encoding:
Text File  |  1995-03-02  |  3.2 KB  |  94 lines
  1. #############################################################################
  2. File:                Comment.FPL
  3. Author:                Jesper Skov
  4. Email:                jskov@iesd.auc.dk
  5. Short:                Easy source code commenting
  6. Version:            2.1
  7. Date:                02.03.95
  8. Local settings:        quite a few!
  9. Global settings:
  10. Keysequence:        "amiga ;" and "amiga :"
  11. Type:                function
  12. Prereq:
  13. Copyright:            © 1994-1995, Jesper Skov
  14.                     Use/distribute according to the terms of GNU GPL.
  15.                     (See the file 'COPYING.GNU' for more info!)
  16. #############################################################################
  17.  
  18. FUNCTION
  19.   The comment functions have been completely rewritten to improve
  20.   control of how the comments look. With these functions it should be
  21.   a bit easier to keep your code well commented :)
  22.  
  23.   Key-bindings: <amiga ;> InsertComment
  24.                 <amiga :> LineComment
  25.  
  26.  
  27.   The InsertComment function is a copy-cat of the Emacs "indent-for-comment"
  28.   function. The variable "comment_start_skip" is a regular expression
  29.   describing how to find a comment on the line. It must therefore match
  30.   the string you put in "comment_start". This variable and "comment_end"
  31.   describe how the comment looks.
  32.  
  33.   The default values are:
  34.    comment_start_skip : "//\\*+ " - a / followed by one or more *'s and a
  35.                                     space.
  36.    comment_start      : "/* "
  37.    comment_end        : " */"
  38.  
  39.   These give you the standard C comment style (/*<comment>*/).
  40.  
  41.   I personally use these values:
  42.    comment_start_skip : "////+ " - two or more /'s, followed by a space.
  43.    comment_start      : "// "
  44.    comment_end        : "" (empty)
  45.  
  46.   Which gives me C++/FPL comment style (// <comment>EOL).
  47.  
  48.   Activating this function on a line which already has a comment, will
  49.   try to indent the comment to the correct "comment_column" and place
  50.   the cursor after the string matching comment_start_skip.
  51.   
  52.  
  53.   The LineComment function gives you an easy way of (visually) splitting the
  54.   source code into function/routine "areas". When invoking this function
  55.   you will be asked for a describing text, which will be right justified
  56.   in the comment block. Example:
  57.  
  58. //»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» This comment is created by LineComment ««
  59.  
  60.   The width of the comment block may be controlled with the "wall_right"
  61.   variable. The appearance of the line comment is defined by the three
  62.   variables below. Their default values are also listed:
  63.  
  64.    line_comment_start : "//"
  65.    line_comment_body  : "»"  (This variable must be a single character!)
  66.    line_comment_end   : "««"
  67.  
  68.   An empty string cancels the operation (as does the Cancel gadget :)
  69.  
  70.  
  71.   You may change the variables by activating the function CommentPrefs(),
  72.   which should also be accessible in the menu:
  73.   Customizing->Package settings->Comment
  74.   (this depends on what Daniel thinks of my idea, though =)
  75.  
  76.  
  77. HISTORY (REV)
  78.   02.03.95 (1)    Put CommentPrefs in the menu.
  79.   26.02.95 (0)    Rewritten from scratch. Much better commenting!
  80.   05.11.94 (2)    Added right_wall constructor.
  81.   23.10.94 (1)    ReadInfo("linelength") -> ReadInfo("line_length")
  82.   09.10.94 (0)    Initial revision
  83.  
  84. BUGS
  85.   Nah, not today anyway :)
  86.  
  87.  
  88. IDEAS
  89.   Kill comment.
  90.   Wrapped comment (continue writing on next line).
  91.  
  92. SEE ALSO
  93.   C.J.Cherryh's "The Paladin" (ISBN: 0-671-65417-9)
  94.