Next: , Previous: Sub Elements, Up: Documenting Your Code


3.7 Synonyms

Rather than using generic header names as a Module, Element and Sub Elements we can use more specific synonyms that will make documentation more readable.

Some examples:

See Headers for a complete list of existing headers.

     Example: A better readability thanks to synonyms  
      1  Package: MyPkg
      2
      3  Unit: MyUnit
      4
      5    MyUnit contains some essential routines.
      6
      7    This routines are the result of many years of
      8    hard work.
      9
     10    I hope they will help to save mankind.
     11
     12  Function: Max -- Return largest of two values.
     13
     14    Max returns the maximum of A and B.
     15
     16    Parameters:
     17      - A -- first value
     18      - B -- second value
     19
     20  End Unit: MyUnit
     21
     22  End Package: MyPkg