Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Remark

Add a Remark callout to the Quick Help for a symbol using the Remark delimiter. Multiple Remark callouts appear in the description section in the same order as they do in the markup.

Works with:

  •    Playgrounds

  • ✓ Symbol documentation

Syntax

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

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

Example

  1. /**
  2.  An example of using the remark field
  3.  - Remark:
  4.  The performance could be reduced from N-squared to
  5.  N-log-N by switching patterns.
  6. */
image: ../Art/MFR_symbol_field_remark_2x.png