Xcode Inline Documentation

By John Daub on Feb 05, 2019


About

Over the years, Xcode has used different means of providing inline documentation. Starting with Xcode 7, a new approach was introduced. While it contains many similarities to Markdown, Apple’s Markup provides a structured and robust mechanism for providing documentation that not only reads well in the source code file, but also enables robust Playgrounds and integration with Xcode’s Quick Help.

While Xcode’s Markup functionality applies to both Playgrounds and Quick Help, there are differences between the two. Since we’re working in Swift code, we’ll focus on that side of Markup. For information on Markup in Playgrounds, consult Apple’s Markup Formatting Reference Guide.

In this screencast, you’ll learn how to document your Swift code using Xcode’s Markup support, and Jazzy.

Questions this Screencast Answers:

- How can I document my code?
- How do I write documentation in Xcode?
- How do I use Jazzy to generate documentation?

Basic knowledge or experience building iOS applications is recommended.

For the More Curious...

Xcode Markup Formatting Reference
Jazzy GitHub
Clarus, the Dogcow
BNR Guide to iOS
BNR Guide to Swift
iOS & Swift Courses

Transcript

Transcripts are only available for subscribers. Create an account today to access our collection of screencasts, skill packs, and more.

Downloads

Project files are only available for subscribers. Create an account today to access our collection of screencasts, skill packs, and more.

Comments