提问人：L. Kvri 提问时间：1/21/2012 最后编辑：CœurL. Kvri 更新时间：11/19/2023 访问量：26384
在 Xcode 中自动生成方法注释
Auto generate method comment in Xcode
问：
Xcode 中有没有办法自动生成方法注释，类似于您在 Eclipse 中对 javadoc 注释所做的操作。
例如，在方法声明前一行按下 /**，eclipse 会自动生成方法注释的骨架。
答：
29赞
Tim
1/22/2012
#1
为此，您可以使用代码片段库。它不会自动为每个参数生成占位符，但它仍然非常有用。这是你要做的：
- 在代码的某处写出一个示例注释块。
- 插入您希望显示名为“xyz”的占位符的位置。（这些类似于参数完成占位符，因此您可以在它们之间按 Tab 键并覆盖它们。
<#xyz#>
例如：
/**
* Method name: <#name#>
* Description: <#description#>
* Parameters: <#parameters#>
*/
- 打开右侧边栏。在底部窗格中，单击两个大括号图标以调出代码片段库。
- 选择文本并将其拖动到代码片段库中。
- 它将创建一个新的。双击它，在弹出窗口中单击编辑，然后给它一个完成快捷方式（例如，用于评论块的 comblk。
现在，当您在编辑器中的任意位置键入“comblk”时，会出现自动完成弹出窗口，您可以按回车键粘贴代码片段。将选择第一个占位符，您可以开始键入方法的名称。点击选项卡切换到描述，依此类推。
不理想，但总比没有好。片段是一个好主意，苹果还没有完全完成实施。
评论
1赞
Harshit Gupta
5/1/2013
很酷。但我渴望拥有一些功能，如下面解释的那样。当您单击一些内置的目标 C 方法时，在右侧栏的快速视图中，可以看到该方法的所有相应详细信息。我也希望我的方法也能得到同样的展示。如果可能的话，请告诉我。
8赞
codeetcetera
8/5/2014
#2
您可以使用这个很棒的插件。
https://github.com/onevcat/VVDocumenter-Xcode
124赞
Tomas Ivan
10/19/2016
#3
您可以使用快捷方式创建标题文档：
⌘ + ⌥ + /
其中
= Command
= Option（在 Windows 兼容键盘上按 Alt） ⌘ ⌥
评论
3赞
GrizzlyBear
1/5/2018
有谁知道是否可以切换到多行注释，而不是单行 ' \\\ ' ？？\***\
2赞
mretondo
7/17/2018
应为 ⌥ = 选项：）
13赞
pallavi
3/7/2018
#4
选择要为其生成注释的代码，然后按 快捷键
CMD + ALT + /
将为所选方法自动生成注释。
15赞
yoAlex5
3/15/2019
#5
Xcode 注释
您可以使用注释语法来生成文档：
Editor -> Structure -> Add Documentation- ⌘ command ⌥ option /
- <minimal_description>
Swift 文档示例：
/// <#Description#>
///
/// - Parameter param: <#param description#>
/// - Returns: <#return value description#>
/// - Throws: <#throws value description#>
func fun(param: String) throws -> String? {
return false;
}
3赞
Christoph
9/21/2022
#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 {
}
重要：在使用此快捷方式之前，应始终将光标放在 method-name 中。
评论