如何：创建任务列表注释

2008-08-18

更新：2007 年 11 月

“任务列表”所显示的代码中的注释以开发语言注释标记开始。在注释旁边，“任务列表”还显示了一个默认的任务标记（如 TODO、HACK 或 UNDONE）或自定义的注释标记。“任务列表”中显示的注释数目可能因您使用的项目类型而异。对于 Visual Basic 和 Visual C#，“任务列表”会显示解决方案中的所有注释。对于 Visual C++ 项目，“任务列表”仅显示编辑器中当前处于活动状态的文件中的注释。

“任务列表”注释可用于指示各种要在所标记位置完成的任务，包括：

要添加的功能；
要更正的问题；
要实现的类；
错误处理代码的位置标记；以及
要在文件中检查的提醒。

同“任务列表”的其他项一样，双击任何注释项都将显示“代码编辑器”中指示的文件，并跳转到标记的代码行。

向“任务列表”添加注释

在代码编辑器中打开源代码文件。
在要标记的代码行中使用 <marker><token> 作为注释的开头，其中 <marker> 是开发语言的注释标记，而 <token> 是识别的“任务列表”注释标记（如 TODO、HACK 或 UNDONE）或自定义注释标记的名称。

说明：

若要以编程方式添加任务标记，请设置 TaskList 的 DefaultCommentToken。
利用描述该任务的文本完成注释。例如：
```
// TODO Fix this function.
```
- 或 -
```
' HACK Update this procedure.
```
在“视图”菜单上，单击“任务列表”。

随即显示“任务列表”。
在“类别”列表中单击“注释”。

“注释”列表将显示注释文本。可以单击任何“任务列表”注释以在“代码编辑器”中激活文件并跳转到注释标记的代码行。

说明：
若要以编程方式添加任务标记，请设置 TaskList 的 DefaultCommentToken。

更改注释或将其从任务列表中移除

在“代码编辑器”中打开代码文件进行编辑。
修改或删除代码中的注释。

更改注释的默认优先级

在“工具”菜单上单击“选项”。
展开“环境”文件夹，然后单击“任务列表”。
在“标记列表”中选择要更改默认优先级的注释标记。

说明：

无法更改 TODO 注释的优先级。
在“优先级”下拉列表中选择不同的优先级类型。
单击“确定”。

说明：
无法更改 TODO 注释的优先级。

创建自定义注释标记

在“工具”菜单上单击“选项”。展开“环境”文件夹，然后单击“任务列表”。

随即显示 “选项”对话框 ->“环境”->“任务列表”。
在“注释标记”框中，键入自定义标记的“名称”。
从“优先级”列表中选择“正常”、“低”或“高”。
单击“添加”，再单击“确定”。

有关向“标记列表”添加自定义标记的更多信息，请参见如何：创建自定义注释标记。

示例

// 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 注释放在代码文件中的任何位置。“任务列表”注释最适于指示必须在特定代码行或代码段完成的任务。而不适于对常规开发任务进行过多描述。

请参见

通过