Eclipse + GITみたいな環境で
多人数でJavaを開発しているとレビュー指摘だったり
要件待ち、不具合だったりするものをコード内にコメントとして
残しておくと便利だったりします。
その際に使うコメント、過去、あまり気にしてこなかったのですが
最近よく使うようになってきたので、備忘録として残しておきます。
コメントの意味
- TODO:hogehoge
⇒ 要件待ちで実装できないものやそもそも、未実装なもの。 - FIXME:hogehoge
⇒ コードが間違っていて修正が必要なもの。
また、Interfaceクラスに対して、APIを追加し、別の人に実装してもらうもの
その場合
FIXME:○○さん hogehoge
という使い方をする。 - XXX:hogehoge
⇒ 基本的には不具合。ただし、正常ケースでは問題は起こらないものに対して使う
使用用途は限定的。
※ hogehoge には任意でコメントを記載する
コメント箇所の確認方法
Eclipse の場合
１．メニューの[ウィンドウ]->[ビューの表示]->[その他]を選択
２．表示された子画面で、[一般]フォルダを選び、[タスク]ビューを選択
３．タスクビューの[▽]をクリックし、[内容の構成]を選ぶ
４．確認したいコメントの内容で構成を作成する
この時、[スコープ]を設定すると、特定のプロジェクトのみに絞り込むことも可能
(たくさんのプロジェクトで作業している場合に便利)
※ ワーキング・セットを使用すると、任意の複数プロジェクトを
絞り込み対象とすることができる