Swift注释直接看这个Apple 的官方文档注释就可以《Markup Formatting Reference》可

写完函数使用快捷键 `⌥ + ⌘ + /` ，为代码生成文档注释


/// <#Description#>

/// - Parameter name: <#name description#>

/// - Returns: <#description#>

func sayHello(to name: String) -> String {

    return "Hello, \(name)!"

}

内容样式

这样标记代码片段

这样加粗 强调重点

斜体表示强调

/// 这是一个示例函数，介绍参数及其作用。
///
/// 你可以使用标准的 Markdown 语法来美化你的注释，
/// 比如 **这样加粗** 强调重点，或者 `这样` 标记代码片段。
///
/// - Parameter name: 用户的名称，可以使用 `*斜体*` 表示强调。
/// - Returns: 一句包含 **加粗** 的问候语。
func sayHello(to name: String) -> String {
    return "Hello, \(name)!"
}

也常用标记📌

// MARK: 这个是标示
// MARK: - 这个是带分割线的标示

用于标记代码结构，而且在 Xcode 中右边 mini map 中可以看到

// TODO: 这个下边要写一些代码，实现某个目的。
// TODO: - 多了一条分割线。

这个用来提示下一步编写代码的目的或者实现逻辑。

// FIXME: 这个地方要修理一下。

提示这个地方的代码需要修复，存在某种需要修复问题。

或者手动加警告⚠️

#warning("手动加警告")

✍️ 文档注释 (Documentation Comments)

这是你给类、方法等添加说明，供 Xcode 的 Quick Help 识别和展示的地方。语法是 /// 或 /**。

/// 这是一个示例函数，介绍参数及其作用。
///
/// 你可以使用标准的 Markdown 语法来美化你的注释，
/// 比如 **这样加粗** 强调重点，或者 `这样` 标记代码片段。
///
/// - Parameter name: 用户的名称，可以使用 `*斜体*` 表示强调。
/// - Returns: 一句包含 **加粗** 的问候语。
func sayHello(to name: String) -> String {
    return "Hello, \(name)!"
}

当你按住 Option 键并点击 sayHello(to:) 函数时，Quick Help 弹窗里的“这样加粗”、“斜体”和“加粗”等字样就会按照你所指定的样式显示出来。

🧪 Playground 渲染注释 (Rendered Markup)

在 Playground 中，这种格式化效果更明显。你可以把注释变成图文并茂的“富文本”文档。

开始你的“富文本注释”：如果你想让 Playground 把代码上方的一段文字识别为富文本，需要用 //: 或 /*: 开头。
渲染你的注释：写完后，可以通过菜单栏 Editor -> Show Rendered Markup 来查看最终效果，视觉上会清晰许多。
写一个可以点击的文档：你甚至可以在注释里直接添加指向其他页面的链接。

//: # 这是一个一级标题
//: 欢迎来到我的 Playground 文档。
//: 这里可以使用 **粗体** 和 *斜体* 等样式。

🧘‍♀️ 普通注释不支持粗体

需要注意的是，这里讨论的格式化，仅针对上文提到的文档注释和 Playground 里的渲染注释。

如果你只是写普通的注释（单行 // 或多行 /* ... */），Markdown 语法是不会生效的。在这些地方，** 和其他符号就只是普普通通的字符。

💡 Xcode 小贴士：MARK、TODO、FIXME

除了 Markdown，Swift 中还有几个特殊的注释标记，不是用来加粗文字的，而是用来在 Xcode 的功能菜单里做章节标记的（如果你用过这类标记，它们的格式稍有不同），比如 // MARK: - 这是一个章节名、// TODO: - 待办事项 或 // FIXME: - 待修复的Bug。

了解更多细节：

如果你希望更系统地了解所有注释的 Markdown 语法，可以查阅 Apple 的官方文档《Markup Formatting Reference》。
如果你想深入探索 Swift 最强大的文档工具，可以看看关于 DocC 的官方说明。

Swift注释

写完函数使用快捷键 ⌥ + ⌘ + / ，为代码生成文档注释