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

TODOの使い方を知らなかったのでメモ。
 
EclipseやXcodeなど、多くのエディタで共通してソースコード中にタスクとして作業メモを登録しておくことができる。コードを書いてて怪しいと思ったところや心配なところに残しておくと良い。
 
書き方は簡単で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, HACK, XXXなどのコメントもあるようだが、これらについてはまた後日にまとめる。
 
 
以上
 
 
参考
会社の先輩からの指導

Article written by

コメントを残す