swift - 如何转义 Swift 文档注释标注?

标签 swift xcode documentation escaping headerdoc

我在 Swift 中有以下文档注释:

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

表示“警告”的行不会在 Xcode 中呈现,因为“- 警告”是 swift 文档注释中的关键字标注。我怎样才能逃避标注?

最佳答案

这不是一个完美的解决方案,但您可以用反引号 (`) 将 Warning 括起来。这将稍微改变其显示样式:

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

Comments

关于swift - 如何转义 Swift 文档注释标注?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40119091/

相关文章:

Swift SpriteKit 使用 3 个节点设置碰撞/接触位掩码

ios - 如何使用 "swipe"在 swift 中控制段?

iphone - 按下快门后立即保存图像 iOS

未找到 C# 文档 <include>

c# - 我应该如何编写 XML 注释以避免在摘要和返回标记之间重复自己?

ios - UIAlertAction 处理程序在错误的时间调用?

ios - 根据矩形请求设置属性。 iOS, swift

ios - 如何等待 Swift 3 中的 Firebase 异步读取调用?

ios - 如何在 Xcode 7 中启用_BITCODE?

ruby - 如何在 Markdown 格式的 YARD 文档中插入项目符号 (<li>) 元素