Xcode注释自动完成（appledoc风格）

Question

Xcode注释自动完成（appledoc风格）

5

我发现编写接口文档特别痛苦，因为需要亲自输入所有内容。所以我想肯定不止我一个人有这种情况，开始寻找减轻我的痛苦的方法，但没有找到太多信息。

我的问题是，有没有快捷方式或方法可以让Xcode自动完成我的注释？例如，如果我键入`/** + [tab]`，希望自动完成如下注释：

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

谢谢！

- xidew

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Caleb · Accepted Answer

使用Xcode的代码段功能。您可以创建一个带有任何文本的代码段，并添加要填充的文本项。要创建代码段，只需在Xcode编辑器中选择一些文本并将其拖入代码段库中。您可以设置完成快捷方式，例如m-comment 可以成为您的标准方法注释：

snippet editor

输入m-comment 的前几个字符就会显示整个快捷方式（和任何其他选项），接受完成后将添加带有等待填充参数部分的注释。通常情况下，您可以从一个字段跳到另一个字段：

inserted comment

您可以使用<# 和 #> 将文本中的某个部分指示为要填充的字段，例如：<#方法名称#>。

当然，Objective-C 的一个优点是方法名称通常告诉您参数是什么。在注释中重复这样的信息似乎是不必要的额外工作。 Xcode 3 具有更好的脚本支持，其中包含可自动生成具有参数的HeaderDoc注释的脚本。但它们没有被广泛使用，可能是因为那种类型的注释并不真正有用。