TODO以外のアノテーションコメントを使い分けて開発をしよう

突然ですが皆さん「アノテーションコメント」を使っていますか?

プログラミングでの開発において、アノテーションコメントは一目で開発状況を認知させ、開発効率を向上させることができます。

私自身、自分が過去に書いたアノテーションコメントに幾度も助けられました。

当記事ではいつもTODOしかアノテーションコメントを使っていなかった私が、TODO以外のアノテーションコメントがあることを知り、それらを利用するようになって更に開発効率が向上した経緯から、TODO以外の開発の現場で役に立つアノテーションコメントを紹介したいと思います。

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

そもそも、アノテーションコメントとは?って人のために説明します。

アノテーションコメントとは、コメントに付帯情報を付加するものです。

よりわかりやすくするために、実際のコードを見てみましょう。

ここでのアノテーションコメントは、TODOを指します。

# TODO:tomatoは野菜じゃないかも。後で確認する。」はコメントですが、TODOを付与することによって、自分がしなければならないことを明確にコメントで表現することができます。

ヒロヤン
コメントだけだと、コメントを見過ごしてしまうこともあると思います。

何がいいのか

アノテーションコメントを書くことで何がいいのか。

先ほどは視覚的に、自分がしなければならないことを明確にわかると書きましたが、実際にIDE(統合開発環境)において、必然的にハイライトがかかります。

以下はVSCodeの例になります。

VSCodeに限らず、EclipseやAtomエディタなどでも自動でハイライトがかかります。

アノテーションコメント一覧

というわけでアノテーションコメントの有用性がわかったところで、実際のアノテーションコメントの一覧を紹介します。

アノテーションコメント意味
TODOあとでやる
FIXME既知の不具合があるコード
HACKあまりキレイじゃない解決案
XXX危険!!大きな問題がある
NOTE結果のロジックの説明
REVIEWコードの見直しが必要
OPTIMIZEコードの最適化が必要
CHANGED旧コードと何が変わったのか
WARNING気をつけて

私が一番よく使用するVSCodeでは、TODOからNOTEまでがデフォルトでハイライトがかかります。

それ以外のIDEでもEclipseやAtomでもハイライトがかかるものと、かからないものがありますのでその辺はあなたの開発環境に合わせて使い分けてください。

最後に

いかがでしたでしょうか。

私も個人開発を始めたばかりの頃は、TODOしか使わなかったのですがそれ以外のアノテーションコメントの存在を知ってから取り入れてからは開発効率が上がりました。

是非開発時は使い分けをしてあなたの開発効率を上げてみてください。

以上が「TODO以外のアノテーションコメント一覧を見て使い分けよう」の紹介記事になります。

コメントを残す

メールアドレスが公開されることはありません。