Добавление комментариев к программам
Когда вы пишете код, это хорошая практика, чтобы добавить комментарии, которые описывают код. Комментарии позволяют другим понять ваш код и могут обновить память, когда вы вернетесь к нему позже. Во время разработки и тестирования программы можно также использовать комментарии, чтобы закомментировать любой код, который не должен запускаться.
В Live Editor можно вставлять линии текста до и после кода, чтобы описать процесс или код. Текстовые строки обеспечивают дополнительную гибкость, такую как стандартные опции форматирования и вставка изображений, гиперссылок и уравнений. Дополнительные сведения см. в разделе Создание Live скриптов в Live Editor.
Примечание
Когда у вас есть MATLAB® файл кода (.m) содержащий текст, который имеет символы в кодировку , отличную от вашей платформы, когда вы сохраняете или публикуете файл, MATLAB отображает эти символы как искаженный текст. Live скрипты и функции (.mlx) поддерживает хранение и отображение символов во всех локалях.
Чтобы добавить комментарии к коду MATLAB, используйте процент (%) символ. Строки с комментариями могут появиться где угодно в файле с программой, и можно добавить комментарии в конец строки кода.
Для примера:
% Add up all the vector elements. y = sum(x) % Use the sum function.
Чтобы прокомментировать несколько строк кода, используйте операторы блочных комментариев, %{ и %}. The %{ и %} операторы должны появляться отдельно на линии, которая непосредственно предшествует и следует блоку текста справки. Не включать другой текст в эти линии.
Для примера:
a = magic(3); %{ sum(a) diag(a) sum(diag(a)) %} sum(diag(fliplr(a)))
Чтобы прокомментировать выбор, выделите строки кода, перейдите на вкладку Editor или Live Editor и нажмите
кнопку. Можно также ввести Ctrl+R. Чтобы удалить код выбранных линий, нажмите
кнопку или введите Ctrl+T.
Чтобы прокомментировать часть оператора, которая охватывает несколько линии, используйте эллипсис (...) вместо знака процента. Для примера:
header = ['Last Name, ', ... 'First Name, ', ... ... 'Middle Initial, ', ... 'Title']
Редактор и Live Editor включают инструменты и элементы контекстного меню, которые помогают добавлять, удалять или изменять формат комментариев для 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')
По умолчанию, когда вы вводите комментарии в редактор и Live Editor, текст переносится, когда он достигает ширины столбца 75. Чтобы изменить столбец с текстом комментария или отключить автоматическое перенос комментариев, перейдите на вкладку Home и в разделе Environment нажмите
Preferences. Выберите MATLAB > Editor/Debugger > Language и измените настройки Comment formatting. Чтобы настроить Comment formatting настройки в Online™ MATLAB, выберите Editor/Debugger > MATLAB Language.
Редактор и Live Editor не переносят комментарии с:
Заголовки секций кода (комментарии, которые начинаются с
%%)Длинный непрерывный текст, такой как URL
Маркированные элементы списка (текст, который начинается с
*или#) на предыдущую линию