在Xcode中自动生成方法注释

Question

Xcode中是否有一种方法可以自动生成方法注释，类似于您在Eclipse中为javadoc注释所做的操作。

例如按，你可以在方法声明之前点击/ **一行，eclipse会自动生成方法注释的骨架。

Answer 1

您可以使用创建标题文档的快捷方式：

⌘ + ⌥ + /

其中
⌘ =命令
⌥ =选项（Windows兼容键盘上的Alt）

Answer 2

您可以使用Code Snippets库进行此操作。它不会自动为每个参数生成占位符，但它仍然非常有用。这是你做的：

1. 在某处的代码中写出示例注释块。
2. 将<#xyz#>插入您希望显示名为“xyz”的占位符的位置。 （这些类似于参数完成占位符，因此您可以在它们之间切换并覆盖它们。）

例如：

/**
 * Method name: <#name#>
 * Description: <#description#>
 * Parameters: <#parameters#>
*/

1. 打开右侧边栏。在底部窗格中，单击两个花括号图标以显示代码段库。
2. 选择并将文字拖至代码段库。
3. 它会创建一个新的。双击它，在弹出窗口中单击编辑，然后给它一个完成快捷方式（例如，用于注释块的comblk。）

现在，当您在编辑器中的任何位置键入“comblk”时，会出现自动完成弹出窗口，您可以点击返回粘贴到代码段中。将选择第一个占位符，您可以开始键入方法的名称。点击标签切换到说明，依此类推。

不理想，但总比没有好。片段是一个很好的主意，Apple还没有完成实现。

Answer 3

1. 选择要为其生成评论的代码，然后按 快捷键

   CMD + ALT + /

2. 将为所选方法自动生成注释。

Answer 4

你可以使用这个很棒的插件。

https://github.com/onevcat/VVDocumenter-Xcode

Answer 5

按⌘命令 + ⌥选项 + / 或Editor -> Structure -> Add Documentation

/// <#Description#>
///
/// - Parameter param: <#param description#>
/// - Returns: <#return value description#>
/// - Throws: <#throws value description#>
func fun(param: String) throws -> String? {
    return false;
}

了解更多Markup Formatting Reference