Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Note

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

Works with:

  • ✓ Playgrounds

  • ✓ Symbol documentation

Syntax

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

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

Playground Example

  1. /*:
  2.  - note:
  3.   "There is nothing either good or bad, but thinking makes it so."
  4.  \
  5.  \
  6.  Hamlet in (*Hamlet, 2.2*) by William Shakespeare
  7. */
image: Art/MFR_note_2x.png

Quick Help Example

  1. /**
  2.  An example of using the note field
  3.  - note:
  4.  This method returns an estimate.
  5.  Use `reallyAccurateReading` to get the best results.
  6.  */
image: ../Art/MFR_symbol_field_note_2x.png