ソースコードへのTODOの書き方

TODOやFIX MEやXXXなどのコメントを総称してアノテーションコメントと呼ぶ。
アノテーションコメントはEclipseやXcodeなど、多くのエディタで共通してソースコード中にタスクとして作業メモを登録しておくことができる。

TODOの書き方は簡単でTODO:というキーワードをコメントに含めれば良い。

// TODO: 文章 担当名 日付

XcodeではTODO:の直後に必ず半角スペースを入れなければならないので注意が必要である。

TODOの確認方法

TODOの確認方法は、Eclipseであれば、メニューからウィンドウ->ビューの表示->タスクを選ぶと、画面下部のウィンドウにタスクというタブが追加され、そこから確認することができる。

Xcodeであれば、ソースファイルを開くと画面上部に表示されるMySampleApp->MySampleApp->main.m->No Selectionという記述のNo Selectionの部分をクリックすると表示される。

エディタによってTODOの書き方に差異がある

例えば、Eclipseなら以下のように記述してもTODOの扱いになる。

// TODO 文章 担当名 日付

Eclipseではコロン:が無くても動作する。逆にXcodeではコロン:が無いと動作しない。
冒頭に書いたTODOの書き方だとEclipseとXcodeの両方に対応しているのでそちらを使用することを推奨する。

TODO以外にもFIX MEやXXXなどのアノテーションコメントもあるが、コードレビューを用いたワークフローで作業する場合はあまり使わないかもしれない。

参考
会社の先輩からの指導