Xcode 注释自动补全(appledoc 风格)

Question

我发现记录我的界面特别痛苦，因为我需要自己输入所有内容。所以我想我一定不是唯一一个这样的人，并开始寻找一种方法来减轻我的痛苦，但没有找到太多。

我的问题是，是否有快捷方式或方法让 Xcode 自动完成我的评论？例如，我非常希望输入 /** + [tab]它自动完成为:

/**
 * [cursor here]
 * 
 * (maybe some pre-populate a list of arguments for the method below)
 */
- (void)test:(NSString *)testString another:(NSString *)another;

谢谢!

Answer 1

使用 Xcode 的片段功能。你可以用你想要的任何文本创建一个片段，并在文本中添加要填充的项目。要创建一个片段，只需在 Xcode 编辑器中选择一些文本并将其拖到片段库中。您可以设置完成快捷方式，例如 m-comment可能是您的标准方法评论:



输入 m-comment 的第一位然后显示整个快捷方式(和任何其他补全)，并接受补全添加一条注释，其中包含等待填写的参数化部分。像往常一样，您可以从一个选项卡到另一个:



您可以通过将文本的给定部分括在 <# 中来指明文本的给定部分是要填写的字段。和 #> ，如:<#method name#> .

当然，Objective-C 的强项之一是方法名一般会告诉你参数是什么。在评论中重复这一点似乎是不必要的额外工作。 Xcode 3 更好地支持包含脚本的脚本，这些脚本会自动生成带有参数的 HeaderDoc 注释。然而，它们并没有被广泛使用，可能是因为这些类型的评论并没有真正的用处。