Visual Studio Code で TODO などを分かり易く表示する拡張機能 TODO Highlight

ryomatsu

5年前

プログラムを記述する際、作業中の場所にコメントに TODO などと書いてメモを残す事がある。あとで直すべき場所であることを示すための重要なコメントだが、通常エディタはコメントを薄い色で表示する事が多く、目立たない事も多い。

Visual Studio Code でも同様にコメントは薄く表示されてしまうが、TODO などの表記を目立たせたいのであれば TODO Highlight という拡張機能を試してみると良さそうだ。

この拡張機能を利用すると、以下のように TODO と書いた場所にハイライトをつけ、より目立つようになる。

標準では TODO: と FIXME: の二種類をハイライトするようになっているが、設定により別の語句を追加することもできる。

TODO などをハイライトするだけでなく、ハイライト対象となっているコメントをリストで表示する機能も搭載されている。

このようプロジェクト内にある TODO や FIXME などのコメントを一覧で表示できるため、どこを作業するべきなのかが分かり易くなる。

なお標準では js や html, php, css などの一部の拡張子のみしか検索対象となっていないため、それ以外の言語を利用するのであれば todohighlight.include の設定を行おう。

コメントに TODO などを記述してメモを残す事が多いのであれば、導入しておくと非常に便利になると思う。