При написании кода рекомендуется добавлять комментарии, описывающие код. Комментарии позволяют другим понять ваш код и могут обновить память, когда вы вернетесь к нему позже. Во время разработки и тестирования программы можно также использовать комментарии для комментирования любого кода, который не требуется запускать.
В интерактивном редакторе можно вставлять строки текста до и после кода для описания процесса или кода. Текстовые строки обеспечивают дополнительную гибкость, такую как стандартные параметры форматирования и вставка изображений, гиперссылок и уравнений. Дополнительные сведения см. в разделе Создание сценариев в интерактивном редакторе.
Примечание
При наличии файла кода MATLAB ® (.m), содержащий текст, который имеет символы в кодировке, отличной от кодировки вашей платформы, при сохранении или публикации файла MATLAB отображает эти символы как искаженный текст. Сценарии и функции в реальном времени (.mlx) поддерживает хранение и отображение символов на всех языках.
Чтобы добавить комментарии к коду MATLAB, используйте процент (%) символ. Строки комментариев могут отображаться в любом месте файла программы, а комментарии можно добавлять в конец строки кода.
Например:
% Add up all the vector elements. y = sum(x) % Use the sum function.
Для комментирования нескольких строк кода используйте операторы block comment, %{ и %}. %{ и %} операторы должны появляться одни на строках, которые непосредственно предшествуют и следуют за блоком текста справки. Не включайте в эти строки другой текст.
Например:
a = magic(3); %{ sum(a) diag(a) sum(diag(a)) %} sum(diag(fliplr(a)))
Чтобы прокомментировать выделенный фрагмент, выделите строки кода, перейдите на вкладку «Редактор» или «Интерактивный редактор» и нажмите
кнопку. Также можно ввести Ctrl + R. Чтобы раскомментировать выбранный код строк, нажмите
кнопку или введите Ctrl + T.
Чтобы прокомментировать часть инструкции, которая охватывает несколько строк, используйте многоточие (...) вместо знака процента. Например:
header = ['Last Name, ', ... 'First Name, ', ... ... 'Middle Initial, ', ... 'Title']
Редактор и интерактивный редактор включают инструменты и элементы контекстного меню, которые помогают добавлять, удалять или изменять формат комментариев для кода MATLAB, Java ® и C/C + +. Например, предположим, что этот длинный текст помещен в строку с комментариями.
% This is a program that has a comment that is a little more than 75 columns wide. disp('Hello, world')
кнопку. Комментарий переносится в следующую строку:% This is a program that has a comment that is a little more than 75 % columns wide. disp('Hello, world')
По умолчанию при вводе комментариев в редакторе и интерактивном редакторе текст переносится, когда достигает ширины столбца 75. Чтобы изменить столбец, в который переносится текст комментария, или отключить автоматическое перенос комментариев, перейдите на вкладку Главная и в разделе Среда щелкните
Настройки. Выберите MATLAB > Редактор/отладчик > Язык и измените настройки форматирования комментариев. Для настройки параметров форматирования комментариев в Online™ MATLAB выберите «Редактор/Отладчик» > «Язык MATLAB».
Редактор и интерактивный редактор не переносят комментарии:
Названия разделов кода (комментарии, начинающиеся с %%)
Длинный смежный текст, например URL-адреса
Маркированные элементы списка (текст, начинающийся с * или #) на предыдущую строку