Вопрос

How can I indicate inline code blocks like this in Appledoc comments?

Backticks just read as backticks in Xcode Quick Help panel.

enter image description here

I'd really love to have NSStringFromClass codified somehow.

Это было полезно?

Решение

Use @p before a word to place it in monospaced font.

///
/// @summary does some stuff
///
/// Alias for @p NSStringFromClass actually.
///

Code preview

Here's a pretty solid overview of available features.

Другие советы

Start the code block with a tab character.

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top