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

• [VisualStudio] 開啟檔案失敗 : To prevent possible data loss before loading the designer, the following errors must be resolved問題  這兩天在開發專案時遇到神奇的事情，要點擊開發好的類別檔案時竟然跳出錯誤，錯誤畫面很像之前在寫 Webform 自訂 UserControl 時異常畫面，錯誤訊息為 'To prevent possible data loss before loading the designer, the following errors must be resolved: ，這篇就就針對此問題的解決方式做簡單分享，若是有不清楚或是錯… Read More
• [.NET] Web API找不到 bin 底下的 roslyn csc.exe ?發生情境 從版控 Git 上抓下新專案要進行建置時，發生建置失敗的事件錯誤訊息如下 Could not find a part of the path 'D:\git\projectName\bin\roslyn\csc.exe'. 從建置失敗的錯誤訊息中可以很清楚看到失敗是因為 bin 底下少 roslyn\csc.exe 檔案，之前也遇過類似的案例，在此簡單記錄一下遇到這問題時該如何處理 甚麼是 Roslyn ?  Roslyn 是… Read More
• [.NET] Default 和 NativeImage 資料夾問題 收到同事反應公司 Server C:\ 硬碟空間嚴重不足，確認後發現 C:\errors 資料空間占了 25g 而且還以驚人的速度成長中，進到資料夾底下查看分 Default 與 NativeImage folder 存放各種應用程式 Log ，如下圖所示 其中竟然還有 w3wp.exe，到底這些是如何記錄的呢 ? 本篇文章簡單記錄解決問題的過程 解決方案 為了追根究柢，點開其中 w3wp.exe 資料… Read More
• [typescript] 如何得知 Visual Studio 使用 Typescript 的版本?前言 近期工作都在使用 Typescript 進行開發，要如何得知目前Typescript 版本呢?  取得目前版本方法 Visual Studio 2017  專案按右鍵 > Properties > TypeScript Build Tab > TypeScript Version此專案就是使用 2.3 version，如果要修改的話就選要用的版本即可 注意 : 異動編譯版本有可能部分方法會不支援造… Read More
• [VisualStudio] 解決 Visual Studio 偵錯時啟動緩慢問題問題  接獲朋友詢問在使用 Visual Studio 進行 debug 偵錯時緩慢，原本從按下 F5 很快就可進行偵錯現在都要 30 秒以上才可完成，過去經驗得知造成 debug 啟動緩慢時會有幾種原因，Symbol 設定為 Microsoft Server 加載、debug breakpoints、或是 sln 專案檔設定異常都有可能造成此問題，如果在找不出問題就可能要使用 FusionLog 來釐清緩慢原因，這篇就就針對… Read More