HOW TO：建立工作清單註解

發行項
08/21/2008

更新：2007 年 11 月

[工作清單] 會顯示程式碼中以開發語言之註解資料標記開頭的註解。在註解旁邊，[工作清單] 也會顯示預設的工作語彙基元 (Token) (例如：TODO、HACK 或 UNDONE)，或是自訂的註解語彙基元。在 [工作清單] 中顯示的註解數量，會根據您正在處理的專案類型而有所變化。若使用 Visual Basic 和 Visual C#，[工作清單] 會顯示方案中的所有註解。若使用 Visual C++ 專案，[工作清單] 只顯示在目前編輯器中作用的檔案內所找到的註解。

[工作清單] 註解可用以指出在標記的位置待完成的各種工作，包括：

要加入的功能
要修正的問題
要實作的類別
放置錯誤處理程式碼的資料標記
在檔案中要檢查的提醒

使用其他的 [工作清單] 項目，您就可以按兩下任何註解項目以顯示 [程式碼編輯器] 中指定的檔案並跳至標記的程式碼行。

將註解加入工作清單

在 [程式碼編輯器] 中開啟原始程式碼檔。
在您想要以 <marker><token> 標記的程式碼行上開始註解，其中 <marker> 是開發語言的註解資料標記，而 <token> 則是可辨識的 [工作清單] 註解語彙基元，例如 TODO、HACK 或 UNDONE，或是自訂註解語彙基元。

注意事項：

若要以程式設計的方式加入工作語彙基元，請設定 TaskList 的 DefaultCommentToken。

注意事項：
若要以程式設計的方式加入工作語彙基元，請設定 TaskList 的 DefaultCommentToken。

以描述工作的文字完成註解。例如：

// TODO Fix this function.

-或-

' HACK Update this procedure.

按一下 [檢視] 功能表上的 [工作清單]。

就會顯示 [工作清單]。
在 [分類] 清單中按一下 [註解]。

[註解] 清單會顯示註解文字。您可以按一下任何 [工作清單] 註解以便在 [程式碼編輯器] 中啟動檔案並跳至註解標記的程式碼行。

若要變更註解或從工作清單移除註解

開啟要在 [程式碼編輯器] 中編輯的程式碼檔。
修改或刪除程式碼中的註解。

變更註解的預設優先順序

在 [工具] 功能表上按一下 [選項]。
展開 [環境] 資料夾，然後按一下 [工作清單]。
在 [語彙基元清單] 中，選取要變更預設優先權的註解語彙基元。

注意事項：

您無法變更 TODO 註解的優先權。
在 [優先權] 下拉式清單中，選取不同的優先權類型。
按一下 [確定]。

注意事項：
您無法變更 TODO 註解的優先權。

若要建立自訂註解語彙基元

在 [工具] 功能表上按一下 [選項]。展開 [環境] 資料夾，然後按一下 [工作清單]。

就會顯示選項對話方塊、環境、工作清單。
在 [註解語彙基元] 方塊中，輸入您自訂語彙基元的 [名稱]。
從 [優先權] 清單中選取 [一般]、[低] 或 [高]。
按一下 [加入]，再按 [確定]。

如需將自訂語彙基元加入至 [語彙基元清單] 的詳細資訊，請參閱 HOW TO：建立自訂註解語彙基元。

範例

// The following C# code file contains several TODO reminders. 
// Note that each line task reminder begins, like this comment, 
//    with the C# comment indicator, '//'.

// TODO: Add standard code header comment here.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Windows.Forms;
// TODO: Add references to specific resources here.

namespace TodoExample
{
partial class TodoExample : Form
   {
      public TodoExample()
         {
            InitializeComponent();
         }
   }
}
// TODO: It is even possible to add comments at the end.

此範例示範可將 TODO 註解置於程式碼檔的任何位置上。[工作清單] 註解最好是用來指出特定程式碼行或區段上所必須完成的工作。較不適用於一般開發工作中較為冗長的描述。

請參閱