広告あり

【Visual Studio】TODOコメントの表示と使い方

VisualStudio

Visual Studioでコーディングをしている時に、後からやろうと思ってTODOコメントを残しておくことがあります。このTODOコメントをVisual Studioの機能で一覧表示して管理・確認する方法について、解説していきたいと思います!

[スポンサーリンク]

TODOコメントの表示と使い方

環境

Visual Studio 2022 Version 17.13.0

TODOコメントの書き方

// TODO: 例外処理未実装

通常のコメントと同じように「//」を入力した後に「TODO:」を入れ、続けてコメントを入力します。

最近のVisual Studioでは、「//」の直後に「TODO」(大小文字区別なし)と区切り文字(コロン:や半角スペース)を入れればある程度自由な形でも認識されるようです。
古いVisual Studioでは、「//」の後に半角スペースを入れた上記書き方の例の形でないと認識されませんのでご注意ください。

TODOコメントの一覧表示

Visual Studioのメニュー「表示」 > 「タスク一覧」から一覧表示で管理・確認できます。

デフォルトではVisual Studioの画面下部に「タスク一覧」の窓が表れて、TODOコメントが一覧表示されます。表示されない場合は「TODOコメントの書き方」を再度チェックしてみてください

タスク一覧では各項目(「説明」「プロジェクト」「ファイル」「行」)をクリックするとその項目で並び替えができますので、TODOコメントの管理や確認に活用してみてくださいね。

TODO以外のトークンの追加

TODOコメントの「TODO」の部分はトークンと呼ばれていて、デフォルトでは以下のトークンが登録されています。

  • HACK – 実装済みだが、あとでコードのリファクタリングや改善が必要。
  • TODO – 未実装や実装中などでさらにコードの追加などが必要。
  • UNDOE – 未完成のためさらにコードを編集する必要がある。
  • UnresolvedMergeConflict – コードのマージ(統合)に失敗した箇所に自動で追加される。

上記のように簡単な説明を書きましたが、僕自身はほとんどTODOで済ませてしまっていたりします。。。
また、トークンは以下の手順で自分で追加することもできます。

Visual Studioのメニュー「ツール」 > 「オプション」でオプションを表示。

「環境」 > 「タスク一覧」で出てくる「タスク一覧のトークン」で「名前:」に好きな文字(例:「NOTE」)を入力して「追加」ボタンを押す。

これで、入力した「名前」がTODOなどと同じように「タスク一覧」に表示されます。
僕の場合は、「NOTE」を登録して「どうしてこういう内容で実装したのか」を残していたりします。

まとめ

今回は、Visual StudioにおけるTODOコメントの書き方とタスク一覧に表示させる方法について解説させていただきました。
コーディングをしていると色々なことを思い出したりして忘れないようにTODOコメントを残しますが、後から「どこだったっけ?」となりがちです。
Visual Studioの機能でTODOコメントを活用して抜け漏れや実装忘れなどを防いでいきましょう!

[スポンサーリンク]

\ おすすめ書籍 /



この記事を書いた人
だんご丸

鉄鋼系SE歴 10年
金融系SE歴  6年
現在は音楽出版社のSE

●保有資格
初級システムアドミニストレータ
(現:ITパスポート)
基本情報技術者
応用情報技術者
情報セキュリティスペシャリスト
(現:情報処理安全確保支援士)
ネットワークスペシャリスト
情報セキュリティマネジメント
AWS認定クラウドプラクティショナー
AWS認定ソリューションアーキテクト - アソシエイト

だんご丸をフォローする
VisualStudio
[スポンサーリンク]
[スポンサーリンク]
だんご丸をフォローする
[スポンサーリンク]
タイトルとURLをコピーしました