在Xcode IDE中使用// TODO注释

时间:2014-01-27 00:30:28

标签: xcode comments todo

有人可以告诉我这是IDE应该如何工作,还是我不理解// TODO评论功能是如何工作的。当我放置一个// TODO时,Xcode会在跳转栏中添加一个TODO部分。多个TODO将多个部分放在TODO注释中作为部分标题。

我看到的问题是,在我的TODO评论之后出现的任何方法都包含在跳转栏中的TODO部分中。为什么Xcode会在评论后自动添加所有方法作为TODO的一部分?

也许我错过了为什么会这样做,或者说我做错了。有人可以为我提供一些澄清吗?

谢谢!

Example

1 个答案:

答案 0 :(得分:1)

不确定是否有// TODO特殊注释标记。有TODO:FIXME:MARK:MARK: -(用于放置分隔符)。 MARK: - Some Text将使用分隔符放置一些文本。还有// ???:// !!!:-它们也会产生标记-只需尝试一下即可(它们可能无法在Swift中使用)。

// TODO(不带:)不会创建任何标记(从Xcode 10开始)。

您可以在构建时使用某些类型的注释来生成警告。 选择项目-> Build Phases,然后按“ +”按钮添加另一个阶段。创建时选择Run Script。添加为脚本主体(确保Shell为/bin/sh

KEYWORDS="TODO:|FIXME:|\?\?\?:|\!\!\!:"
find "${SRCROOT}" \( -name "*.swift" \) -print0 | \
xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | \
perl -p -e "s/($KEYWORDS)/ warning: \$1/"

Xcode project settings for Build Phases

现在,在构建时,您将收到带有注释文本的警告。

Custom warnings generated from comments

您可以自由地将关键字限制为修复和!!!只要。 要预先获得这些警告(而不是等待实际的构建),只需将新创建的Run Script部分移到顶部。