アノテーションコメント
annotation comment ; codetags ; tokens
アノテーション + コメント
コメントにメタデータを付加するもの
コードの欠陥がわかりやすくなる
よく使われる記法と意味
BODGE
a workaround.
BUG
a known bug that should be corrected.
CHANGED:
コードをどのように変更したか。
DEBUG:debug.icon
a known bug that should be corrected.
FIXME:FIXME.icon
既知の不具合があるコード。修正が必要。
should be corrected.
HACK:HACK.icon
あまりきれいじゃないコード。リファクタリングが必要。
a workaround.
KLUDGE
a workaround.
NOTE:NOTE.icon
なぜ、こうなったという情報を残す。
used to highlight especially notable gotchas.
OPTIMIZE:
無駄が多く、ボトルネックになっている。
REVIEW:
意図した通りに動くか、見直す必要がある。
TODO:TODO.icon
あとで追加、修正するべき機能がある。
something to be done.
UNDONE
a reversal or "roll back" of previous code.
WARNING:WARNING.icon
注意が必要。
XXX:XXX.icon
危険!動くけどなぜうごくかわからない。
warn other programmers of problematic or misguiding code
ドキュメンテーションコメント
コメント(comment)
grep
レビュー