[VS2017] Visual Studio 顯示代辦清單 - TODO List

前言 
最近在與同事討論問題時，主管看到代碼中有 // TODO 當下詢問同事 Visual Studio 該如何看到 TODO comment 清單，一問之下發現同事不太清楚 Visual Studio 該如何看到 TODO 清單，或許是因為不常用沒太多人知道或是不熟悉，自己也是因為之前上過 Will 保哥的課程才明白，這篇就簡單介紹在 Visual Studio 如何透過 Task List 找到 TODO comment list 及如果需要自訂 token 時該如何新增。

探索問題
Task List
在 Visual Studio 中有提供 Task List 視窗可以協助找到 TODO comment，開啟方式如下
Step 1 : Visual Studio > View > Task List 

Step 2 : Task List 視窗會顯示 TODO 註解內容，左上角可以針對尋找的範圍區分是要目前專案、所有專案、已開啟專案等範圍

Code comments
接著我們來看一下，在 MSDN 中有提到 Code comments 分為三個部分

• The comment marker :  // 
• The token, for examples : TODO
• The comment : This is a book

上述講的很像文言文，直接舉個例子來看

// TODO: This is a book

其中 TODO 是預先定義好的 token, 因此會出現在 Visual Studio Task List 視窗中，在 Visual Studio 中預設有提供四種 token，分別是 TODO、HACK、UNDONE、UnresolvedMergeConflict 等四種，不區分大小寫，如上圖所示小寫的 todo 也可以找的到，可以透過以下方式找到相關設定
Step 1 : Tool > options > Environment > Task List

自訂 token
除了內建的四種 token 外還提供自定義 token 功能，舉例想新增一個 token 名為 TOGGLE，輸入 token name，接著定義該 token 的 Priority 重要程度，再按下新增按鈕即新增完成，如下圖所示

接著在代碼中加入 code comments 為 TOGGLE 的 comments，就可以在 Task List 視窗中看到新的 token 內容資訊

除了新增需要的 token 之外，還可以針對內建的 token 進行 Priority 的修改 (TODO 不能異動 ) ，希望透過以上基本介紹，希望可以對於 token 有更多認識 :)

參考
使用工作清單
How to: Create Task List Comments

Related Posts:

• [NETCore] ASP.NET Core 建立排程服務 - 使用 Generic Host 搭配 Quartz.Net - Part 1前言 最近有個需求是固定時間取得特定資料進行修改，在查詢相關資料之後決定使用 ASP.NET Core Generic Host 為出發，在搭配 .NET 中熱門的排程套件 Quartz.Net，測試完畢之後再將程式註冊為 Windows Service 服務就可滿足使用者的需求，這篇文章是整理開發時的重點流程為系列文，給有需要使用 ASP.NET Core 開發排程相關應用程式需求的朋友一些參考，若有問題或是錯誤的地方歡迎各位高手給予… Read More
• [Azure] App Service Diagnostics - Collect Memory Dump 前言 前兩篇分別介紹了 App Service Diagnostics 中的 Collect .Net Profiler Trace 與 Auto heal，分別都可以透過工具來蒐集雲端伺服器的緩慢問題分析與蒐集記憶體資訊，這一篇則是介紹如何 dump 目前伺服器 memory 的資料，以及有多個伺服器的時候該如何抓取特定的 Server memory data。若對於上述內容有問題或是不清楚的地方，歡迎提出來一起討論。 Colle… Read More
• [Free] 更新 ASP.NET Core 的兩三事 電子書 前言 之前有整理 ASP.NET Core 相關文章變成一本電子書 Something about ASP.NET Core 並放在 Github 上供人自行取用 (詳細可以參考 這篇 文章)，去年也有撰寫一些相關的議題因此在過年期間也針對電子書做更新，新增的內容及章節如下 建立 Azure Container Registry 並整合 Microsoft Team 通知 如何在 ASP.NET Core Midd… Read More
• [conference] .NET Conf 2021 - 初探 OpenTelemetry - 蒐集遙測數據的新標準 分享心得 參加好幾屆 .NET Conf 每次都是收穫滿滿，今年被主辦單位也是技術管理者論壇志工 Kyle 推坑在 .NET 年度盛會邀請分享，原本十分不好意思但想到之前已經有在 COSCUP 與 MOPCON 分享過兩場，於是決定分享最近有興趣的議題 OpenTelemetry 開源框架， 依舊保持緊張就斷片的正常發揮，在一開始主持人介紹完開場就立刻忘詞 (掉漆again)，很高興可以參予 Study4.TW 10年盛會，可以有機會在講師… Read More
• [NETCore] 如何在 ASP.NET Core Middleware 加上單元測試 Unititest前言 Middleware 在 ASP.NET Core 開發時是個很常見的功能，概念很像 ASP.NET Application Life cycle 管線的 Handler 機制 (若對於 Life Cycle 想了解更多可以看之前寫的文章 Application Life Cycle)，提供開發者可以在 Request 進入到 Application 前加上客製化的邏輯，實務上用起來挺方便的也蠻好用的，在加上 middleware 相關… Read More