如何逃避Swift doc评论Callout?

时间:2016-10-18 22:26:26

标签: swift xcode documentation escaping headerdoc

我在Swift中有以下文档评论:

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

表示"警告"不会在Xcode中呈现,因为" - 警告"是swift doc评论中的关键字标注。我怎样才能逃脱标注?

2 个答案:

答案 0 :(得分:0)

不是一个完美的解决方案,但你可以用反引号(`)包围警告。这会稍微改变它的显示风格:

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

Comments

答案 1 :(得分:0)

您可以在关键字前使用零宽度的空格(​

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

screenshot of rendered documentation