【Eclipse】初心者向け！ToDoコメントの使い方・活用方法を解説

お疲れ様です。
はるさらと申します。

皆様はJava開発でEclipseを使用している際に
ToDoコメントを使用していますでしょうか？

私は存在を知らず、ソースレビューで指摘されて
IT8年目にして初めて知りました。。

Java開発でEclipseを使っていると、
コードの中に「あとで修正したい」、
「未実装の箇所が分かるようにしたい」と思うことがあります。
そんなとき便利なのが ToDoコメント 機能です。

Eclipseには標準で「// TODO」というコメントを
検出して一覧表示してくれる仕組みが用意されています。
この記事では ToDoコメントの基本的な使い方から、
活用方法・注意点 までを紹介していこうと思います！

Table of Contents

ToDoコメントとは？

ToDoコメントは、Eclipseが特別に認識してくれるコメントです。
通常のコメントに「TODO」を含めるだけで、
Eclipseの タスクビュー に自動的に表示されます。

public class Sample {

    public void process() {
        // TODO: 入力チェックの処理を追加する
        System.out.println("処理を開始します");
    }
}

上記のように「// TODO:」と書いておけば、
後から「ここに作業が残っている」とすぐに確認できます。

１．タスクビューを開く

２．タスクビューにTODO一覧が表示される

これにより「未処理タスクの一覧」をEclipse上で管理できるようになります。

実装途中で「ここは後でやる」とメモを残すのに便利です。

// TODO: ログイン処理のバリデーションを追加する

「動作はするけど、改善が必要」という場所を記録できます。

// TODO: 例外処理を追加してエラーを潰す

複数人で開発しているときに「誰かがやるべきタスク」をコードに直接埋め込んでおけます。
Git管理とも相性がよく、コメントを見れば誰が何を残したかすぐにわかります。

Eclipseは TODO 以外にも FIXME や XXX など
任意のキーワードを認識させることが可能です。

設定方法:
ウィンドウ → 設定 → Java → コンパイラー → タスクタグ

ここで独自タグを追加すれば、

// FIXME: メモリリークの可能性あり

といったコメントもタスクビューで管理できます。

書きっぱなしにしない
TODOコメントはあくまで「一時的なメモ」です。放置すると技術的負債になります。
チームでルールを決める
「TODOは必ず解消する」「FIXMEはリリース前に確認する」といった
運用ルールを決めると効果的です。
課題管理ツールとの使い分け
JIRAやRedmineなどの課題管理ツールと併用するときは、
「細かい作業はTODO、全体タスクはチケット管理」と使い分けると混乱を防げます。