red character 'A' without the horizontal bar Achraf Kassioui

Xcode Comments

Blog / Apple Dev,

Xcode has a syntax to style comments, which I find very useful for code documentation and presentation.

Xcode provides various ways to style and organize code comments:

// Regular comment

/// Comment written in regular characters, not monospace characters.

/// `inlineCode`

// MARK: - A title that creates a line separator

// MARK: A title that is visible in the minimap

// TODO: A flag for a todo item

// FIXME: A flag for an issue to fix

/**
 
 # Documentation Block with a Title
 
 Function signature documentation:
 - Parameter name: description of the parameter.
 
 */
 
/// Function signature documentation:
/// - Parameter parameterName1: a description of the first parameter.
/// - Parameter parameterName2: a description of the second parameter.

The code above would render like this in Xcode:

Xcode-Comments.png