TODOマークを使って実装忘れ防止

はじめに

　個人的に一旦中身が空のメソッドだけを作って実装を後回しにしようということがよくあり、コメントでその旨を書いて残したりはするのですが、そのことすら忘れてしまったりすることがあります。

　そこでXcodeを用いた開発においてTODOや、FIXMEなど書いたところがあると警告が出るように設定し、常に見える化する方法を実践します。

方法

1. プロジェクトナビゲーターの中からプロジェクトを選択します。
2. TARGETSの中のBuild Phasesを選択し、+を選択します。
3. New Run Script Phaseを選択し、

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

例えば、TODO:とFIXME:を対象とするためには上のようなbuild scriptを貼り付けます。

のようになります。

例えば、

というコードがあれば、

というようにTODO:のあとに続く文字列が題名となって警告を出すことに成功しました。
(ただし、１度ビルドする必要がある。)