ブログ

Android開発者の皆さん、こんにちは。
早速ですが、コードの中に // TODO をよく書いている方、多いのではないでしょうか？
ただ、開発を進める中で、「これは要修正…でもTODOではないし…」というケース、ありませんか？

今回は、そんなときに便利な「アノテーションコメントの拡張テクニック」をご紹介します。
Android Studio（IntelliJ系IDE）で TODO 以外のコメントも検出して、ツールウィンドウに表示できるように設定する方法です！

「TODO」だけじゃもったいない！使いたいコメント分類たち

開発中には様々な意図を残すコメントを書きますが、それを分類しておくことで、後からの検索や整理がとても楽になります。たとえば、以下のように使い分けてみてはいかがでしょうか？

これらを使い分けることで、ただの「TODOの山」が、意味のある情報分類になります。

Android Studioでアノテーションを追加する方法

IntelliJ系IDEでは、実はこれらを簡単に登録できます。以下の手順で、あなたのIDEを「TODOだけじゃない」便利ツールに変えましょう！

手順

1. メニューバーからAndroid Studio > Settings... を開く

2. 左側のメニューからEditor > TODO を選択

デフォルトではTODOとFIXMEのコメントに対応しています。

3. Patterns セクションに+で新しい正規表現を追加します。

4. OK を押して保存！

ポイント部分に触れていきます。

2を確認した時点で、デフォルトではTODOとFIXMEが用意されていることがわかります。特に何もしなくても以下のように書くとアノテーション認識してくれます。通常コメントは灰色のテキスト色ですが、アノテーションコメントは色付きなのが分かります。

3の段階で試しにNOTEを追加してみようと思います。

+ボタンを押すとPatternの追加のモーダルが表示されるので、正規表現のパターンとアイコンや色を設定します。この例では、NOTEコメントとそのコメントを黄色(E8E209)にする設定にしています。

OKを押してAndroid Studioに適用(Apply)をすると、以下のようにコメントを認識してくれました。

色が変わるだけ？これで何が変わるの？

追加したキーワードはすべて、エディタ内のツールのTODO タブに一覧表示されます。これにより、コード内に書いた// FIXME: も、// NOTE: も、すぐに見つけられるようになります。

たとえば…

• バグ修正が必要な箇所 → FIXME で管理
• 最適化アイデア → OPTIMIZE でメモ
• ロジックの裏話 → NOTE に残しておく

このちょっとした工夫で、コードに残す知識やタスクが、可視化され、整理されるんです。

チーム開発でも活躍！

このアプローチは、個人開発だけでなくチーム開発でも大きな武器になります。

• Pull Request に FIXME コメントが含まれていたら、マージ前にチェック可能
• NOTEを通じて設計意図を共有できる
• TODO をタスクチケットと紐付けやすくなる

IDEの機能を少し広げるだけで、コードの「見える化」が大きく進みます。

終わりに

アノテーションコメントの活用は、簡単に導入できて効果が大きい機能です。
IDEの機能にちょっと手を加えるだけで、日々の開発効率がグンと上がるはずです！

ぜひ一度、あなたのAndroid Studioにも必要なアノテーションを追加してみてください！

おまけ

チームで使う場合は、以下のようにコントリビューションガイドを用意しておくとメンバーに優しいと思います。

### アノテーションコメントルール
- `TODO`: 今後のタスク
- `FIXME`: 修正が必要な問題
- `OPTIMIZE`: 最適化の検討が必要
- `NOTE`: 補足や設計意図
- `HACK`, `XXX`: 回避策、非推奨実装 など

株式会社ウイングドアは福岡のシステム開発会社です。
現在、私達と一緒に"楽しく仕事が出来る仲間"として、新卒・中途採用を絶賛募集しています！
ウイングドアの仲間達となら楽しく仕事できるかも？と興味をもった方、
お気軽にお問い合わせ下さい！