home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Editor / FREDV19A.LHA / FrexxEd / fpl / CommentMode.fpl.readme < prev    next >
Encoding:
Text File  |  1995-08-01  |  3.6 KB  |  102 lines
  1. #############################################################################
  2. File:        CommentMode.FPL
  3. Author:        Jesper Skov
  4. Email:        jskov@iesd.auc.dk
  5. Short:        Easy source code commenting
  6. Version:    2.2
  7. Date:        15.06.95
  8. Local settings:    Quite a few!
  9. Global settings:
  10. Keysequence:    "amiga ;" and "amiga :"
  11. Type:        minor mode
  12. Prereq:
  13. Copyright:    © 1994-1995, Jesper Skov
  14. #############################################################################
  15.  
  16. FUNCTION
  17.   The comment functions have been completely rewritten to improve
  18.   control of how the comments look. With these functions it should be
  19.   a bit easier to keep your code well commented :)
  20.  
  21.   Key-bindings: <amiga ;> InsertComment
  22.                 <amiga :> LineComment
  23.  
  24.  
  25.   The InsertComment function is a copy-cat of the Emacs "indent-for-comment"
  26.   function. The variable "comment_start_skip" is a regular expression
  27.   describing how to find a comment on the line. It must therefore match
  28.   the string you put in "comment_start". This variable and "comment_end"
  29.   describe how the comment looks.
  30.  
  31.   The default values are:
  32.    comment_start_skip : "//\\*+ " - a / followed by one or more *'s and a
  33.                                     space.
  34.    comment_start      : "/* "
  35.    comment_end        : " */"
  36.  
  37.   These give you the standard C comment style (/*<comment>*/).
  38.  
  39.   I personally use these values:
  40.    comment_start_skip : "////+ " - two or more /'s, followed by a space.
  41.    comment_start      : "// "
  42.    comment_end        : "" (empty)
  43.  
  44.   Which gives me C++/FPL comment style (// <comment>EOL).
  45.  
  46.   Activating this function on a line which already has a comment, will
  47.   try to indent the comment to the correct "comment_column" and place
  48.   the cursor after the string matching comment_start_skip.
  49.   
  50.  
  51.   The LineComment function gives you an easy way of (visually) splitting the
  52.   source code into function/routine "areas". When invoking this function
  53.   you will be asked for a describing text, which will be right justified
  54.   in the comment block. Example:
  55.  
  56. //»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» This comment is created by LineComment ««
  57.  
  58.   The width of the comment block may be controlled with the "wall_right"
  59.   variable. The appearance of the line comment is defined by the three
  60.   variables below. Their default values are also listed:
  61.  
  62.    line_comment_start : "//"
  63.    line_comment_body  : "»"  (This variable must be a single character!)
  64.    line_comment_end   : "««"
  65.  
  66.   An empty string cancels the operation (as does the Cancel gadget :)
  67.  
  68.  
  69.   You may change the variables by activating the function CommentModePrefs(),
  70.   which should also be accessible in the menu:
  71.   Customizing->Program->CommentMode
  72.  
  73.   You should be aware of the fact that other minor modes may change the
  74.   settings of this mode. Thereby the comment strings associated with each
  75.   mode (read "type of text") are configurable in the appropriate minor mode's
  76.   preference window (e.g. CMode may set the strings to something like the
  77.   ones described in this document whereas the AsmMode would set the strings
  78.   appropriate to assembler conventions).
  79.  
  80.  
  81. HISTORY (REV)
  82.   15.06.95 (2)    Made into a minor mode (called CommentMode). You should update
  83.         your User.FPL, and make sure that the major modes you use
  84.         enable CommentMode if needed. Check out the FMC documentation.
  85.   02.03.95 (1)    Put CommentPrefs in the menu.
  86.   26.02.95 (0)    Rewritten from scratch. Much better commenting possible!
  87.   05.11.94 (2)    Added right_wall constructor.
  88.   23.10.94 (1)    ReadInfo("linelength") -> ReadInfo("line_length")
  89.   09.10.94 (0)    Initial revision
  90.  
  91. BUGS
  92.   Nah, not today anyway :)
  93.  
  94.  
  95. IDEAS
  96.   Kill comment.
  97.   Wrapped comment (continue writing on next line).
  98.  
  99. SEE ALSO
  100.   FMC.FPL(.readme)
  101.   C.J.Cherryh's "The Paladin" (ISBN: 0-671-65417-9)
  102.