Аннотирование файла облегчает находить области вашего кода, который вы намереваетесь улучшить, завершить или обновиться позже. Чтобы аннотировать файл, добавьте комментарии с текстом TODO, FIXME, или любой текст вашего выбора. После того, как вы аннотируете несколько файлов, запустите Отчет TODO/FIXME, чтобы идентифицировать все файлы кода MATLAB® в данной папке, которую вы аннотировали.
Этот демонстрационный Отчет TODO/FIXME показывает файл, содержащий текст TODO, FIXME и NOTE. Поиск является нечувствительным к регистру.
Используйте Браузер текущей папки, чтобы перейти к папке, содержащей файлы, для которых вы хотите представить отчет TODO/FIXME.
На Браузере текущей папки щелкните
, и затем выберите Reports> TODO/FIXME Report.
Отчет TODO/FIXME открывается в веб-браузере MATLAB.
В окне TODO/FIXME Report выберите один или несколько следующих, чтобы задать линии, которые вы хотите отчет включать:
TODO
FIXME
Флажок текстового поля
Можно затем ввести любой текст в этом поле, включая регулярное выражение. Например, можно ввести NOTETBD, или re.*check.
Определение пользовательского текста или какие линии искать не поддерживаются в MATLAB Online™.
Запустите отчет относительно файлов в текущей папке путем нажатия на 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. Отчет включает в себя линии, которые имеют текст, как задано в текстовом поле, принимая, что вы выбираете текстовое поле.