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


3.8 Function Result

Document the result of the Multiply function is actually documenting Multiply.Result.

We can do as we would for a normal element.

     Example: As a normal element  
      1  Element: Multiply.Result -- The two integers multiplied together.

We can also consider that Multiply.Result is a sub element of Multiply.

     Example: As a sub element  
      1  Function: Multiply -- Multiplies 2 integers.
      2
      3    Sub Elements:
      4      - A      -- first integer
      5      - B      -- second integer
      6      - Result -- The two integers multiplied together.

But the best way is to use a Result header:

     Example: With Result header  
      1  Function: Multiply -- Multiplies 2 integers.
      2
      3    Parameters:
      4      - A -- first integer
      5      - B -- second integer
      6
      7    Result:
      8
      9      The two integers multiplied together.

A Result header can only appear once per element.