プログラミングしていると、あとでやることをソースコード中にコメントとして記述しておくことがあります。
内容としては、機能実装などのTODO系や、修正などのFIXME、といった内容です。
この記事では、TODOやFIXMEなどを便利に使える Visual Studio Code拡張機能を紹介します。
Todo Tree
| item | value |
|---|---|
| Marketplace URL | https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree |
| github | https://github.com/Gruntfuggly/todo-tree |
| Install Command | ext install Gruntfuggly.todo-tree |
Todo Treeはプロジェクトフォルダ内のファイルから「Todo」と「FixMe」を検索してツリー表示してくれる拡張機能です。
拡張機能をインストールすると、左側にツリーのマークが表示されます。
これをクリックすると、「TODO」や「FIXME」のタグを検索してツリー表示してくれます。
検索対象のタグは、Settingsより追加変更が可能です。
TODO Highlight
| item | value |
|---|---|
| Marketplace URL | https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight |
| github | https://github.com/wayou/vscode-todo-highlight |
| Install Command | ext install wayou.vscode-todo-highlight |
TODO Highightは、ソースコード中の「TODO」や「FIXME」のタグを検索して、ハイライト表示してくれる拡張機能です。
ハイライト表示自体はすべての拡張子に対して有効ですが、この拡張機能はプロジェクトフォルダを全検索してリストアップ表示することができます。
リストアップ表示は、「TODO-Highlight: List Highlighted annotations」コマンドで実行します。
リストアップ対象の拡張子は、「Settings」の「Todohighlight: Include」からカスタマイズ可能です。
「Edit in settings.json」をクリックして編集していきます。
TODO Parser
| item | value |
|---|---|
| Marketplace URL | https://marketplace.visualstudio.com/items?itemName=minhthai.vscode-todo-parser |
| github | https://github.com/mt40/vscode-todo-parser |
| Install Command | ext install minhthai.vscode-todo-parser |
Todo Parserは、プロジェクトフォルダのファイルからTODOやFIXMEを検索し、「OUTPUT」ウィンドウへ表示する拡張機能です。
TODOやFIXMEのリストは、ステータスバーのアイコンをクリックして表示します。
2022年6月時点で、TODO Parserがサポートしているプログラミング言語は以下のとおりです。
Java, Javascript, C#, C, C++, F#, Python, Ruby, Coffee Script, R, Haskell, Lua, Go, Perl, Markdown, Css, Scss, Less, Latex, Typescript, Elixir, Shell Script, Twig, Visual Basic, Matlab.
Todo+
| item | value |
|---|---|
| Marketplace URL | https://marketplace.visualstudio.com/items?itemName=fabiospampinato.vscode-todo-plus |
| github | https://github.com/fabiospampinato/vscode-todo-plus |
| Install Command | ext install fabiospampinato.vscode-todo-plus |
Todo+は、「NOTE」や「TODO」をキーワードにプロジェクト内の各ファイルを検索してツリー表示してくれる拡張機能です。
拡張機能をインストールすると、左側のナビゲーションに「✓」マークのアイコンが表示されます。
これをクリックすると。ツリー表示やTODOファイルを見ることができます。
「Todo: Open Embedded」コマンドを実行すると、各キーワードとソースファイルパスが書かれたTODOテキストを出力します。
私のおすすめは、TODO Tree
TOO系拡張機能は本当にたくさん公開されていますが、私はTODO Tree がおすすめです。
理由としては、機能がシンプルで使いやすいこと、ツリー表示してくれるので、全体像を俯瞰しやすいこと、の２点です。
どれにするか迷われている場合は、TODO Treeを試してみてはいかがでしょうか。
Visual Studio Codeは機能ありすぎ！
Visual Studio Codeはオープンソースのコードエディタです。
コードエディタと言いつつも、デバッグもできますし簡易Webサーバも立てられますし、ソースコード中のTODOを検索してツリー表示することもできます。
インストール可能な拡張機能の数は30,000以上と言われており、とても便利な機能が数多くあります。
そのため、Visual Studio Codeを使いこなすには、それなりの情報収集が必要です。
「Visual Studio Code実践ガイド」は、
- Visual Studio Codeの基本的な使い方
- TypeScriptやPythonなど、実際の開発を通した Visual Studio Code機能の紹介
- Visual Studio Code拡張機能の開発方法の紹介
などが収録されており、Visual Studio Codeの機能を体系的に理解するのに最適な書籍です。
電子書籍化されていますので、まずは kindleなどで試し読みしてみてはいかがでしょうか。
コメント