Edited at

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


アノテーションコメントとは


  • コメントにメタデータを付加するものです。

  • コードの欠陥がわかりやすくなります。

# TODO: 変数aがNoneの時、呼び出すときにエラーを吐くことの対応


まとめの経緯

アノテーションコメントを書くときにTODO:ばかり使用していて、TODO:ほどじゃないんだけどなぁ...みたいなことがありまして、他にわかりやすいアノテーションコメントはないだろうかと思いまとめました。

微妙に解釈が異なる可能性があります...


よく使われる記法と意味

記法
意味

TODO:
あとで追加、修正するべき機能がある。

FIXME:
既知の不具合があるコード。修正が必要。

HACK:
あまりきれいじゃないコード。リファクタリングが必要。

XXX:
危険!動くけどなぜうごくかわからない。

REVIEW:
意図した通りに動くか、見直す必要がある。

OPTIMIZE:
無駄が多く、ボトルネックになっている。

CHANGED:
コードをどのように変更したか。

NOTE:
なぜ、こうなったという情報を残す。

WARNING:
注意が必要。


Atomだと

TODO, FIXME, CHANGED, XXX, IDEA, HACK, NOTE, REVIEW, NB, BUG, QUESTION, COMBAK, TEMP, DEBUG, OPTIMIZE, and WARNINGがアノテーションコメントとして認識されて、ハイライトされます。

さらに、todo-showというパッケージをインストールすると、ファイルに点在しているTODOなどのメモを一覧で表示してくれます。

https://atom.io/packages/todo-show


VS Codeだと

https://github.com/Gruntfuggly/todo-tree

こちらも同じようにファイルに点在しているTODOなどのメモを一覧で見ることができます。

Todo tree: Add Tagを設定するだけで、タグを追加できます。デフォルトではTODO,FIXMEのみですが、簡単にアレンジすることができます。