在Xcode中自动生成方法注释

Question

在Xcode中，是否有一种类似于Eclipse为javadoc注释生成方法注释的自动生成方法注释的方式。

例如，您可以在方法声明之前按下/**，然后eclipse会自动生成方法注释的框架。

- L. Kvri

Answer 1

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

⌘ + ⌥ + /

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

- Tomas Ivan

---

正是我所寻找的！ - RestingRobot

有人知道是否可以使用\**和*\ 来切换到多行注释，而不是单行的\\\吗？ - GrizzlyBear

太棒了，where 部分很容易理解。 - haisergeant

应该是 ⌥ = Option :) - mretondo

Answer 2

您可以使用代码片段库来实现此功能。虽然它不会自动为每个参数生成占位符，但仍然非常有用。下面是具体操作步骤：

1. 在代码的某个地方编写一个示例注释块。
2. 在您想要一个名为“xyz”的占位符出现的位置插入<#xyz#>。（这些类似于参数补全占位符，因此您可以在它们之间进行标签切换并覆盖它们。）

例如：

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

1. 打开右侧边栏，在底部面板点击两个花括号图标以打开片段库。
2. 选择并拖动文本到代码片段库中。
3. 它将创建一个新的代码段。双击它，在弹出窗口中点击编辑，并给它一个完成快捷键（例如，对于注释块使用comblk）。

现在，当你在编辑器中任何地方键入 "comblk" 时，自动完成弹出窗口会出现，你可以按返回键将代码片段粘贴进去。第一个占位符将被选中，然后你可以开始输入方法名称。按Tab键切换到描述，以此类推。

虽然不是理想的解决方案，但比没有好。代码段是一个很好的想法，但Apple还没有完全实现。

- Tim

---

很酷。但我渴望拥有像下面解释的一样的一些功能。当你点击一些内置的Objective C方法时，在右侧边栏的快速查看中，可以看到该方法的所有相关细节。我希望我的方法也能显示相同的内容。请告诉我是否可能。 - Harshit Gupta

Answer 3

Xcode注释

您可以使用注释语法来生成文档：

• 编辑器 -> 结构 -> 添加文档
  
• ⌘ command ⌥ option /
• ///<简要描述>

Swift文档示例：

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

官方标记格式参考

- yoAlex5

Answer 4

1. 选择您要生成注释的代码，然后按下快捷键

   CMD + ALT + /

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

- pallavi

Answer 5

您可以使用这个很棒的插件。 https://github.com/onevcat/VVDocumenter-Xcode

- codeetcetera

Answer 6

自 Xcode 14 版本起，快捷键取决于您选择的键盘布局。

英文布局下的快捷键是（与 Xcode 14 之前相同）：

⌘ command + ⌥ option + /

德文布局下的快捷键为：

⌘ command + ⌥ option + ß

如果您不确定，可以在 Xcode 中随时检查这个快捷键。

Editor -> Structure -> Add Documentation

例子：

func exampleMethod(parameter1: String, parameter2: String) -> Bool {  
}

将变成这样：

<#Description#>
 - Parameters:
   - parameter1: <#parameter1 description#>
   - parameter2: <#parameter2 description#>
 - Returns: <#description#>
func exampleMethod(parameter1: String, parameter2: String) -> Bool {
}  

重要提示：在使用此快捷键之前，您应始终将光标置于方法名称中。

- Christoph