Практическое руководство. Создание комментариев для списка задач

Обновлен: Ноябрь 2007

В окне Список задач отображаются комментарии в программном коде, которые начинаются с метки комментария, используемой в данном языке разработки. Рядом с комментариями в окне Список задач также отображаются лексемы задач по умолчанию, такие как TODO, HACK или UNDONE, или пользовательские лексемы комментария. Количество комментариев, появляющихся в списке задач, может изменяться в зависимости от типа разрабатываемого проекта. В Visual Basic и Visual C# в списке задач отображаются все комментарии решения. В проектах Visual C++ в списке задач отображаются только те комментарии, которые содержатся в файле, активном в данный момент в редакторе.

Комментарии списка задач можно использовать для указания самых разных работ, которые необходимо выполнить в помеченном месте, в том числе следующих:

• добавление возможностей;

• устранение проблем;

• реализация классов;

• установка меток для добавления кода обработки ошибок и

• напоминаний для проверки файла.

Как и в случае других записей списка задач, для того, чтобы открыть указанный файл в редакторе кода и перейти непосредственно к помеченной строке кода, достаточно дважды щелкнуть строку комментария.

Добавление комментария в список задач

1. Откройте файл с исходным кодом в редакторе кода.

2. Начните комментарий в строке, которую необходимо пометить, с символов <метка><лексема>, где <метка> — метка комментария, используемая в языке разработки, а <лексема> — имя распознаваемой лексемы комментария списка задач, например TODO, HACK или UNDONE, или пользовательская лексема комментария.

   Примечание.
   Чтобы добавить лексемы задач программными средствами, установите свойство DefaultCommentToken объекта TaskList.

3. Введите текст комментария, описывающий задачу, которую необходимо выполнить. Пример:

   // TODO Fix this function.
   

   — или —

   ' HACK Update this procedure.
   

4. В меню Вид выберите пункт Список задач.

   Откроется окно Список задач.

5. В списке Категории щелкните Комментарии.

   В списке Комментарии отображается текст комментария. Можно щелкнуть любой комментарий в списке задач, чтобы открыть файл в редакторе кода и перейти к строке, помеченный данным комментарием.

Изменение комментария и его удаление из списка задач

1. Для редактирования откройте файл с кодом в редакторе кода.

2. Измените или удалите комментарий в коде.

Изменение приоритета комментария по умолчанию

1. В меню Сервис выберите пункт Параметры.

2. Разверните папку Среда и щелкните Список задач.

3. В разделе Список лексем выберите лексему комментария, приоритет по умолчанию которой следует изменить.

   Примечание.
   Изменить приоритет комментария TODO невозможно.

4. В раскрывающемся списке Приоритет выберите другой тип приоритета.

5. Нажмите кнопку ОК.

Создание пользовательской лексемы комментария

1. В меню Сервис выберите пункт Параметры. Разверните папку Среда и щелкните Список задач.

   Отображается Страница "Список задач", папка "Среда", диалоговое окно "Параметры".

2. В области Маркеры комментариев введите в поле Имя имя пользовательской лексемы.

3. В списке Приоритет выберите одно из значений: Обычный, Низкий или Высокий.

4. Нажмите кнопку Добавить, а затем — кнопку ОК.

   Дополнительные сведения о добавлении пользовательских лексем в список задач см. в разделе Практическое руководство. Создание настраиваемых лексем комментариев.

Пример

// 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 в любой строке кода. Комментарии списка задач особенно удобно использовать для указания работ, которые необходимо выполнить в отдельных строках или разделах кода. Они менее подходят для ввода более длинных описаний задач разработки общего свойства.

См. также

Задачи

Практическое руководство. Пометка кода закладкой

Практическое руководство. Управление списком задач

Ссылки

Список задач (Visual Studio)

Создание XML-примечаний к коду

Окно "Закладки"

Другие ресурсы

Установка закладок в коде