John Daub

Xcode Inline Documentation

John Daub | Feb 05, 2019

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

Subscribers Only

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

Subscribers Only

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

Need Help?

If you get stuck, try starting a discussion with Big Nerd Ranch experts in the community tab.

Related Screencasts

Explore other screencasts related to this topic.

Xcode Configurations vs. Schemes

10 minutes

Targets and configurations and schemes; Oh my! Confused by these Xcode concepts? Curious how using multiple build configurations coupled with schemes can avoid the multiple-target mess? If you’re wondering what this all means and how it can make your developer life better, this video is for you.

Swift Assertions

9 minutes

In this screencast, we’ll learn how to use Swift’s assertion function to code defensively. By the end of this video, you’ll be able to use the assertion functions to help you write stronger, more robust code.

Adopting Configuration Settings Files in Xcode

11 minutes

In this screencast, we will explore how to use Xcode’s Configuration Settings Files - or xcconfig files - and improve our ability to tame the complexity of managing project settings.

Protocol Oriented Dependency Injection

8 minutes

Tight coupling between view controllers in your application can lead to difficult maintenance as you add and remove features. This video will explore how using Protocols can make our Dependency Injection more loosely coupled. This improves the flexibility of the code and makes our application easier to change.

Finding and Fixing Memory Issues

7 minutes

Incorrectly managing memory in our applications can result in hard to find bugs and possible crashes. In this video, we will explore the Memory Graph debugging tool in Xcode and how you can use it to find and fix strong reference cycles in closures.

Using Container Views to Manage Complex Layouts

7 minutes

When you have a complex view controller view, sometimes it is helpful to break up the view into manageable chunks. In this video we will show how you can use container views to simplify the construction of certain layouts. After this video you will know when and how to use these container views in your applications.