Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Invariant

Add an Invariant callout to the description of a symbol using the Invariant delimiter. Multiple Invariant callouts appear in the description section in the same order as they do in the markup.

Use the callout to display a condition that is guaranteed to be true during the execution of the documented symbol.

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

  • * | + | - Invariant: description
  • optional continuation of description

The description displayed in Quick Help for the invariant callout is created as described in Parameters Section.

Example

  1. /**
  2.  An example of using the invariant field
  3.  - Invariant:
  4.  The person reference will not change during the execution of this method
  5. */
image: ../Art/MFR_symbol_field_invariant_2x.png