アノテーションコメントの使い方

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

• ①コメントにメタデータを付与する。
• ②コードの欠陥を理解しやすくする。

+a

• コードを読んでいる時のメモとして残す。

VSCodeの拡張

「TODO Highlight」を使うとハイライトしてくれます。

一覧

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

参考

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