在Xcode中有没有一种方法可以自动生成方法注解,类似于你在Eclipse中为javadoc注解所做的。例如,在方法声明前的一行按下/**,eclipse会自动生成方法注解的框架。
hmmo2u0o1#
创建表头单据可以使用快捷方式:联系我们哪里=命令Alt = Option(在Windows兼容键盘上为Alt)
bpsygsoo2#
你可以使用Code Snippets library来实现这一点。它不会自动为每个参数生成占位符,但它仍然非常有用。下面是你要做的:1.在代码中的某个地方写出一个示例注解块。1.在您希望出现名为“xyz”的占位符的位置插入<#xyz#>。(这些占位符类似于参数完成占位符,因此您可以在它们之间切换并覆盖它们。)举例来说:
<#xyz#>
/** * Method name: <#name#> * Description: <#description#> * Parameters: <#parameters#> */
字符串1.打开右侧边栏,在底部点击两个花括号图标,打开代码片段库。1.选择文本并将其拖到代码段库中。1.双击它,在弹出窗口中点击编辑,然后给予一个完成快捷方式(例如comblk用于注解块)。现在,当你在编辑器的任何地方输入'comblk'时,自动完成弹出窗口就会出现,你可以点击回车键粘贴代码片段。第一个占位符将被选中,你可以开始输入方法的名称。点击tab键切换到描述,等等。虽然不理想,但总比没有好。代码片段是一个不错的想法,苹果还没有完全完成实施。
mwecs4sa3#
Xcode注解
您可以使用注解语法来生成文档:
Swift文档示例:
/// <#Description#> /// /// - Parameter param: <#param description#> /// - Returns: <#return value description#> /// - Throws: <#throws value description#> func fun(param: String) throws -> String? { return false; }
官方标记参考
3phpmpom4#
1.选择要为其生成注解的代码,然后按快捷键
CMD + ALT + /
1.将为所选方法自动生成注解。
ncgqoxb05#
你可以使用这个很棒的插件。https://github.com/onevcat/VVDocumenter-Xcode
uz75evzq6#
从Xcode 14开始,快捷键取决于您选择的键盘布局。英语布局的快捷键是(与Xcode 14之前一样):⌘ command + ⌥ option + /使用德语键盘布局,您必须使用此快捷键:⌘ command + ⌥ option + ß如果你不确定是否可以检查,请在Xcode中检查:
⌘ command
⌥ option
/
ß
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 { }
型
**重要提示:**在使用此快捷方式之前,请始终将光标放在方法名称中。
6条答案
按热度按时间hmmo2u0o1#
创建表头单据可以使用快捷方式:
联系我们
哪里
=命令
Alt = Option(在Windows兼容键盘上为Alt)
bpsygsoo2#
你可以使用Code Snippets library来实现这一点。它不会自动为每个参数生成占位符,但它仍然非常有用。下面是你要做的:
1.在代码中的某个地方写出一个示例注解块。
1.在您希望出现名为“xyz”的占位符的位置插入
<#xyz#>
。(这些占位符类似于参数完成占位符,因此您可以在它们之间切换并覆盖它们。)举例来说:
字符串
1.打开右侧边栏,在底部点击两个花括号图标,打开代码片段库。
1.选择文本并将其拖到代码段库中。
1.双击它,在弹出窗口中点击编辑,然后给予一个完成快捷方式(例如comblk用于注解块)。
现在,当你在编辑器的任何地方输入'comblk'时,自动完成弹出窗口就会出现,你可以点击回车键粘贴代码片段。第一个占位符将被选中,你可以开始输入方法的名称。点击tab键切换到描述,等等。
虽然不理想,但总比没有好。代码片段是一个不错的想法,苹果还没有完全完成实施。
mwecs4sa3#
Xcode注解
您可以使用注解语法来生成文档:
Swift文档示例:
官方标记参考
3phpmpom4#
1.选择要为其生成注解的代码,然后按快捷键
CMD + ALT + /
1.将为所选方法自动生成注解。
ncgqoxb05#
你可以使用这个很棒的插件。
https://github.com/onevcat/VVDocumenter-Xcode
uz75evzq6#
从Xcode 14开始,快捷键取决于您选择的键盘布局。英语布局的快捷键是(与Xcode 14之前一样):
⌘ command
+⌥ option
+/
使用德语键盘布局,您必须使用此快捷键:
⌘ command
+⌥ option
+ß
如果你不确定是否可以检查,请在Xcode中检查:
字符串
范例:
型
将是这样的:
型
**重要提示:**在使用此快捷方式之前,请始终将光标放在方法名称中。