Exponenta Banner
exponenta event banner

Добавить напоминания в файлы

Аннотирование файла упрощает поиск областей кода, которые планируется улучшить, завершить или обновить позже. Чтобы аннотировать файл, добавьте комментарии с текстом TODO, FIXMEили любой текст по вашему выбору. После аннотирования нескольких файлов запустите отчет TODO/FIXME, чтобы определить все файлы кода MATLAB ® в данной папке, для которой были созданы аннотации .

В этом примере отчета TODO/FIXME показан файл, содержащий текст TODO, FIXME и NOTE. Поиск не учитывает регистр.

Работа с отчетами TODO/FIXME

  1. Используйте браузер текущей папки для перехода к папке, содержащей файлы, для которых требуется создать отчет TODO/FIXME.

    Примечание

    Нельзя запускать отчеты, если путь является путем UNC (Universal Naming Convention); то есть путь, который начинается с \\. Вместо этого используйте фактический жесткий диск в системе или подключенный сетевой диск.

  2. В браузере текущей папки щелкните, а затем выберите Отчеты > Отчет TODO/FIXME.

    Отчет TODO/FIXME открывается в веб-браузере MATLAB.

  3. В окне Отчет TODO/FIXME выберите одну или несколько из следующих опций, чтобы указать строки, которые должны быть включены в отчет:

    • TODO

    • FIXME

    • Флажок «Текстовое поле»

      Затем в это поле можно ввести любой текст, включая регулярное выражение. Например, можно ввести NOTE, tbd, или re.*check.

    Указание пользовательского текста или строк для поиска не поддерживается в Online™ MATLAB.

  4. Запустите отчет по файлам в текущей папке, нажав кнопку «» Повторить этот отчет «».

    В окне обновляются и отображаются все строки в файлах MATLAB в указанной папке, содержащие текст, выбранный на шаге 1. Совпадения не чувствительны к регистру.

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

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

Предположим, у вас есть файл, area.m, в текущей папке. Код для area.m появляется на следующем рисунке.

При выполнении отчета TODO/FIXME для папки, содержащей area.m, с текстом TODO и FIXME выделенный и текст NOTE указанный и выбранный, отчет перечисляет:

9 и прямоугольник. (тодо)
14 Исправлено: Область полушария, как ниже?
17 FIXME
21 ПРИМЕЧАНИЕ: Узнайте у менеджера, если нам нужно включить

Обратите внимание, что отчет включает следующее:

  • Строка 9 как соответствие для текста TODO. Отчет содержит строки с выбранным текстом независимо от его размещения в комментарии.

  • Строки 14 и 17 как совпадение для текста FIXME. Отчет соответствует выбранному тексту в файле независимо от его оболочки.

  • Строка 21 как соответствие для текста NOTE. Отчет включает строки с текстом, указанным в текстовом поле, при условии, что выбрано текстовое поле.

Документация MATLAB

Поддержка