Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Complexity

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

Use the callout to display the algorithmic complexity of a method or function.

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

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

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

Example

  1. /**
  2.  An example of using the complexity field
  3.  - Complexity:
  4.  The method demonstrates an inefficient way to sort
  5.  using an O(N\*N\*N) (order N-cubed) algorithm
  6. */
image: ../Art/MFR_symbol_field_complexity_2x.png