// XXX 〇〇〇〇〇〇〇〇
アノテーションコメントというのは、TODO や FIXME のようなタグを先頭につけるコメントのことです。
これらは、どこかに明確に定義があるわけではないので、どうしても人それぞれニュアンスが違うと思いますが、
これまで自分が見たコードの中での使われ方とか、自分の勝手な理解を紹介。
| コメントタグ | 意味 |
|---|---|
| TODO | 未実装。のちのち実装予定。 |
| FIXME | とりあえず動くよう書いたけど、コーディング規約や設計思想を破ってるコード。要修正。 |
| HACK | トリッキーなことやってますよ。 具体例を挙げると、ライブラリで公式にサポートされていない使い方してるとか、ライブラリのバージョン上げたら不具合出そうな使い方とか。 |
| NOTE | この実装になった経緯とか。仕様レベルの説明とか。 |
人によって使い方や意味はまちまちだと思う。