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


3.6 Sub Elements

Documenting elements one by one is not really satisfactory. It's easier to write than XML, but not as readable as one might hope. Fortunately we can do better thanks to Sub Elements.

     Example: Sub Elements  
      1  Package: MyPkg
      2
      3  Module: 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  Element: Max -- Return largest of two values.
     13
     14    Max returns the maximum of A and B.
     15
     16    Sub Elements:
     17      - A -- first value
     18      - B -- second value
     19
     20  End Module: MyUnit
     21
     22  End Package: MyPkg

A Sub Elements section starts by a Sub Elements header on is own line (line 16). Then comes a list off sub elements (line 17-18), in the format ‘- Identifier -- ShortDescription. The short description of a sub element may extend over multiple lines. Sub elements can only have a short description if you want to add a more detailed description use a normal Element header.