Как мне избежать комментариев в Свифтском документе?

У меня есть следующий комментарий документа в Swift:

/**
- Trace
- ↓
- Debug
- ↓
- Information
- ↓
- Warning
- ↓
- Error
*/

Строка с надписью "Warning" не отображается в Xcode, потому что "- warning" - это ключевое слово в быстрых комментариях к документу. Как я могу избежать выноски?

1 ответ

Вы можете использовать пробел нулевой ширины (​) перед ключевым словом:

/**
 - Trace
 - ↓
 - Debug
 - ↓
 - Information
 - ↓
 - ​Warning
 - ↓
 - Error
 */

скриншот предоставленной документации

Не идеальное решение, но вы можете окружить Warning обратными чертами (`). Это немного изменит стиль отображения:

/**
 - Trace
 - ↓
 - Debug
 - ↓
 - Information
 - ↓
 - `Warning`
 - ↓
 - Error
 */

Комментарии

Другие вопросы по тегам