TODO以外のアノテーションコメントまとめ

記法意味
TODO:あとで追加、修正するべき機能がある。
FIXME:既知の不具合があるコード。修正が必要。
HACK:あまりきれいじゃないコード。リファクタリングが必要。
XXX:危険!動くけどなぜうごくかわからない。
REVIEW:意図した通りに動くか、見直す必要がある。
OPTIMIZE:無駄が多く、ボトルネックになっている。
CHANGED:コードをどのように変更したか。
NOTE:なぜ、こうなったという情報を残す。
WARNING:注意が必要。

よくあるのが、とりあえず実装したけど、いまいち自信ないので、あとから見直したい・・・的なやつ。
ようするにTODOにするべきかどうかすらはっきりわかってないケース。

REVIEWにしとくのが無難かなぁ。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です