コーディング時に「アノテーションコメント」を使ってコードを見やすく管理する
アノテーションコメントとは
コードを書いていく上で「適度にコメントを残しておくと、読みやすいコードになる」とよく聞きます。
ただ、コメントの数が多くなってくると「コードの説明をしているコメント」「あとでしたいタスクをメモ書きしているコメント」「なにか理由があって変更してはいけない場所を示している注意書きコメント」などさまざまな種類のコメントが出てきます。
下記のように先頭に「タグ」のような記述を追加しておくと、「そもそもこのコメントは何の目的で残しているのか？」が分かって、把握しやすくなります。
// TODO: あとで引数を追加するまた、あとからファイル検索をしたり拡張機能を使うことで、残タスクの把握もできます。
このように先頭にタグを付けるコメントを「アノテーションコメント（注釈コメント）」と呼びます。
使うタグ名を決めておかないと逆に見にくくなる
たとえば「TODO:」「TODOS:」「TASK:」「CHECK:」のように似たような役割のタグが混在していると、逆に混乱してしまします。
使う数はできる限り少なくして、統一しておかないとあとで検索するときにも不便です。
アノテーションコメントを便利に使うためのVisual Studio Code拡張機能
Visual Studio Codeの拡張機能を使えば、アノテーションコメントをさらに便利に使えます。
Better Comments
Better Commentsはアノテーションコメントに装飾を追加できる拡張機能です。
すべて同じ色でもタグのおかげで把握はしやすくなっていますが、色分けされることでさらに把握しやすくなります。
ミニマップにも表示されますし、コードを流し見するときにも目に付きやすくなります。
Todo Tree
Todo Treeはアノテーションコメントの一覧を表示できる拡張機能です。
「TODO:」はあとから行うタスク用のコメントですが、これを一覧で表示させることで残タスクがすぐ把握できます。
アノテーションコメントの色分けもできますが、Better Commentsの方が機能が多いので、色分けは片方に集約した方が管理しやすいです。
