Добавьте комментарии в код
Когда вы пишете код, это - хорошая практика, чтобы добавить комментарии, которые описывают код. Комментарии позволяют другим изучать ваш код и могут освежить вашу память, когда вы возвращаетесь к нему позже. Во время разработки кода и тестирования, также можно использовать комментарии, чтобы закоментировать любой код, который не должен запускаться.
В Live Editor можно вставить линии текста до и после кода, чтобы описать процесс или код. Текстовые строки обеспечивают дополнительную гибкость, такую как стандартные параметры форматирования и вставка изображений, гиперссылок и уравнений. Для получения дополнительной информации смотрите, Создают Live скрипты в Live Editor.
Примечание
Когда у вас есть MATLAB® файл кода (.m) содержа текст, который имеет символы в кодировке, отличной от вашей платформы, когда вы сохраняете или публикуете свой файл, MATLAB отображает те символы как искаженный текст. Live скрипты и функции (.mlx) поддержите хранение и отображение символов из всех локализаций.
Чтобы добавить комментарии в код MATLAB, используйте процент (%) символ. Строки с комментариями могут появиться где угодно в файле кода, и можно добавить комментарии в конец строки кода.
Например:
% Add up all the vector elements. y = sum(x) % Use the sum function.
Чтобы закомментировать несколько строк кода, используйте операторы блочных комментариев, %{ и %}. %{ и %} операторы должны казаться одними на линиях, которые сразу предшествуют и следуют за блоком текста справки. Не включайте никакой другой текст на этих линиях.
Например:
a = magic(3); %{ sum(a) diag(a) sum(diag(a)) %} sum(diag(fliplr(a)))
Чтобы закомментировать выбор, выберите строки кода, перейдите к вкладке Editor или Live Editor, и в разделе Code, нажмите
кнопку. Также можно ввести Ctrl+R. Чтобы не прокомментировать выбранный код линий, нажмите
кнопку или введите Ctrl+Shift+R. В macOS системах используйте Command+/, чтобы прокомментировать и Command+Option+/, чтобы не прокомментировать. На Linux® системы, используйте Ctrl+/, чтобы прокомментировать и Ctrl+Shift+/, чтобы не прокомментировать.
Чтобы закомментировать часть оператора, который охватывает несколько линий, используйте замещающий знак (...) вместо знака процента. Например:
header = ['Last Name, ', ... 'First Name, ', ... ... 'Middle Initial, ', ... 'Title']
Редактор и Live Editor включают инструменты и элементы контекстного меню, чтобы помочь вам добавить, удалить или изменить формат комментариев для MATLAB, Java®, и код C/C++. Например, предположите, что у вас есть этот длинный текст в прокомментированную линию.
% This is a code file that has a comment that is a little more than 75 columns wide. disp('Hello, world')
кнопку. Комментарий переносится к следующей строке:% This is a code file 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 в MATLAB Online™, выберите Editor/Debugger> MATLAB Language.
Редактор и Live Editor не переносят комментарии с:
Разделите заголовки (комментарии, которые начинаются
с %%)Длинный непрерывный текст, такой как URL
Элементы маркированного списка (текст, который начинается
с *или#) на предыдущую линию