Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Requires

Add a Requires callout to the Quick Help for a symbol using the Requires delimiter. See Precondition for usage.

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

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

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

Example

  1. /**
  2.  An example of using the requires field
  3.  - Requires: `start <= end`.
  4.  - Requires: `count > 0`.
  5. */
image: ../Art/MFR_symbol_field_requires_2x.png