[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:

• [Nuget] 使用 NuGet Package Explorer 製作 Nuget 套件問題  在上一篇介紹了如何架設公司內部 nuger server，架設完畢後會使用 nuget push 指令將開發完 Library 上傳到公司內部 nuget server 上，但每次都要透過手動打指令 push 難道沒有更快的方法了嗎 ? 今天就要來介紹一套好用的工具 Nuget Package Explorer 可以省去打指令的動作，透過 GUI 的介面將開發好的 Library 上傳到共用或是私人架設的 nuget … Read More
• [Nuget] The term 'nuget.exe' is not recognized as the name of a cmdlet, function, script file, or operable program問題  最接開發完 Libary 專案要上傳到 nuget server 時，要將 package 檔案透過指令 push 噴 error 錯誤訊息 nuget.exe : The term 'nuget.exe' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the … Read More
• [Docker] Image operating system "windows" cannot be used on this platform問題 接獲同事詢問在安裝完 Docker for Windows 之後，練習指令 docker pull image 時候跳出異常訊息，訊息內容為 image operating system "windows" cannot be used on this platform ，回想起自己一開始觀念不熟悉時也發生過類似問題，錯誤訊息如下所示 PS C:\marcustung> docker pull someone/image:l… Read More
• [VS2017] Visual Studio 顯示代辦清單 - TODO List前言  最近在與同事討論問題時，主管看到代碼中有 // TODO 當下詢問同事 Visual Studio 該如何看到 TODO comment 清單，一問之下發現同事不太清楚 Visual Studio 該如何看到 TODO 清單，或許是因為不常用沒太多人知道或是不熟悉，自己也是因為之前上過 Will 保哥的課程才明白，這篇就簡單介紹在 Visual Studio 如何透過 Task List 找到 TODO co… Read More
• [Nuget] 架設公司內部 Nuget Server 前言  在開發上常常會遇到某些代碼是跨專案共用的，在 .NET 中會將重複使用的代碼打包成「套件」，其中包含了編譯後的 dll 以及相關的檔案資訊，接著將套件內容上傳到 Nuget Server 上提供開發者下載使用，Nuget server 有分共用與私人主機兩種，共用的 nuget server 上有相當多好用的 libary 供開發者下載，例如常用的 NLog、newtonsoft.json、NUnit...等各種好用的 pack… Read More