Comments and Separators - Txt2FPDoc : Reference Manual

Next: Adding Descriptions, Previous: Minimal Documentation File, Up: Documenting Your Code

3.3 Comments and Separators

     Example: Comments ans separators  
      1  **************
      2  Package: MyPkg
      3  **************
      4
      5  # This is a comment
      6
      7  ~~~~~~~~~~~~~~
      8  Module: MyUnit
      9  ~~~~~~~~~~~~~~
     10
     11  End Module: MyUnit
     12
     13  End Package: MyPkg

Lines starting by ‘#’ are comments and are ignored (line 5).

Lines consisting of a single character from [‘-’, ‘=’, ‘_’, ‘*’, ‘%’, ‘~’] repeated 5 times or more are separators and, like comments, are ignored (lines 1, 3, 7, 9). Using separators increases the readability of documentation.