Добавление напоминаний к файлам

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

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

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

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

    Примечание

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

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

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

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

    • TODO

    • FIXME

    • Флажок текстового поля

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

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

  4. Запустите отчет о файлах в текущей папке, нажав Rerun This Report.

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

    Если необходимо запустить отчет в папке, отличной от указанной в окне отчета, измените текущую папку. Затем нажмите Run Report on Current Folder.

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

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

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

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

Заметьте, что отчет включает следующее:

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

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

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

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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте