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
/*:
- Note:
"There is nothing either good or bad, but thinking makes it so."
\
\
Hamlet in (*Hamlet, 2.2*) by William Shakespeare
*/
Quick Help Example
/**
An example of using the note field
- Note:
This method returns an estimate.
Use `reallyAccurateReading` to get the best results.
*/
Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05