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注释.但是,它们并没有被广泛使用,可能是因为这些评论并没有真正有用.