3. Комментарии в программе
Для описания сложных частей кода используют комментарии. В MATLAB они однострочные и начинаются с символа «%». Всё, что записано после «%» и до конца строки, игнорируется интерпретатором и используется только для пояснений. Важной отметить, что MATLAB по-особому интерпретирует комментарии, которые записаны в начале файла. Они служат для вывода справочной информации о программе.
Первая строка-комментарий (h2 line) – краткая информация о программе. Она отображается при вызове функции help для папки с программами. В этом случае будут выведены h2-строки всех m-файлов директории.
Следующие начальные комментарии содержат расширенную справку и отображаются вместе с h2 при вызове команды help для конкретного m-файла.
Рассмотрим пример.
Создадим в папке D:/matlab/ два файла: function1.m и function2.m:
>> cd D:/matlab/
Файл function1.m:
%
Строка h2
для function1.
% Справка по программе
% function1
function function1
…
Файл function2.m:
% Строка h2 для function2.m
% Справка по программе
% function2
function function2
…
Вызовем справку для папки D:/matlab (необходимо обратить внимание на отсутствие «/» в конце пути):
>> help D:/matlab
Contents of matlab:
function1 – Строка h2 для файла function1.m
function2 – Строка h2 для файла function2.m
Теперь посмотрим подробную информацию о программе:
>> help D:/matlab.function1
Строка h2 для файла function1.m
Справка по программе
Function1
4. Лабораторное задание
Получить у преподавателя задание на разработку программы и разработать её с использованием средств MATLAB.
Результатом выполнения задания должен быть m-файл программы.
Библиографический список
1. Ануфриев, И.Е. MATLAB 7 / И.
Е. Ануфриев, А.Б.
Смирнов, Е.Н. Смирнова. – СПб.: БХВ-Петербург,
2005. – 1104 с.
2. Кетков, Ю.Л. MATLAB 7: программирование, численные методы / Ю.Л. Кетков, А.Ю. Кетков, М.М. Шульц. – СПб.: БХВ-Петербург, 2005. – 752 с.
3. Кондрашов В.Е. MATLAB как система программирования научно-технических расчётов / В.Е. Кондрашов, С.Б. Королёв. – М.: Мир. – 645 с.
Содержание
ВВЕДЕНИЕ………………………………………………….…..1
1. ВИДЫ ПРОГРАММ В MATLAB……………………………2
1.1. Сценарии (скрипты) ………..…………………………..3
1.2. Функции…………………………………………………5
1.3. Основные и локальные функции…………..…………..6
1.4. Вложенные функции…………..…………………………7
1.6. Анонимные функции…………………………………….9
2. УПРАВЛЯЮЩИЕ КОНСТРУКЦИИ………………………11
2.1. Условный оператор if……………………………………11
2.
2.3. Цикл с определённым количеством итераций………..15
2.4. Цикл с неопределённым количеством итераций….. ….16
2.5. Операторы return, break и continue………………….….17
2.6. Функция input……………………………………….…..17
3. КОММЕНТАРИИ В ПРОГРАММЕ……………………..…18
4. ЛАБОРАТОРНОЕ ЗАДАНИЕ ………………………………19
БИБЛИОГРАФИЧЕСКИЙ СПИСОК…………………………19
ОСНОВЫ ПРОГРАММИРОВАНИЯ В MATLAB
МЕТОДИЧЕСКИЕ УКАЗАНИЯ
по выполнению лабораторных работ по дисциплинам
«Вычислительные методы и программные системы»,
«Методы оптимизации в информационных системах»,
«Методы обработки данных» для студентов направлений
Текстовые комментарии MatLab
Урок 2. Установка системы и первые навыки работы
Установка и файловая система MATLAB
Запуск MATLAB и работа в режиме диалога
Новый и старый
облик системы MATLAB 6.
0
Операции строчного редактирования
Команды управления окном
MATLAB в роли суперкалькулятора
О переносе строки в
сессии
Основные объекты MATLAB
Действительные и комплексные числа
Константы и системные переменные
Текстовые комментарии
Переменные и присваивание им значений
Уничтожение определений переменных
Операторы и функции
Применение оператора : (двоеточие)
Сообщения об ошибках и исправление ошибок
Форматы чисел
Формирование векторов и матриц
Особенности задания векторов и матриц
Объединение малых матриц в большую
Удаление столбцов и строк матриц
Операции с рабочей областью и текстом сессии
Дефрагментация рабочей области
Сохранение рабочей области сессии
Ведение дневника
Завершение вычислений и работы с системой
Завершение вычислений
Завершение работы с системой
Что нового мы узнали?
Поскольку MATLAB используется для достаточно сложных вычислений, важное значение
имеет наглядность их описания.
Она достигается, в частности,
с
помощью
текстовых комментариев.
Текстовые комментарии
вводятся с помощью символа
%,
например так:
Примечание
В каждой большой программе
есть свои «ложки дегтя». В MATLAB 6 такой «ложкой дегтя»
является перевод строки при вводе буквы «с» русского алфавита
в командной строке. В итоге ввод комментариев в командной строке на русском
языке превращается в проблему. Пока автор может порекомендовать заменять русское
«с» на английское, что на виде текстового комментария никак не
сказывается. Не рекомендуется вводить русскоязычные комментарии и в тесты
m-файлов при подготовке их в редакторе/отладчике (он будет описан позже).
Это нередко делает программы неработоспособными.
Обычно первые строки m-файлов служат для описания их назначения, которое
выводится на экран дисплея после команды » help Имя_файла.
Считается правилом хорошего тона вводить в m-файлы достаточно подробные текстовые
комментарии. Без таких комментариев даже разработчик программных модулей быстро
забывает о сути собственных решений. В текстовых комментариях и в символьных
константах могут использоваться буквы русского алфавита — при условии, что установлены
содержащие эти буквы наборы шрифтов (см. примечание . выше).
Нравится
Твитнуть
MATLAB Programming Style Guide — Комментарии
Целью комментариев является добавление информации к коду. Обычно комментарии используются для объяснения использования, предоставления справочной информации, обоснования решений, описания ограничений и упоминания необходимых улучшений.
Опыт показывает, что лучше писать комментарии одновременно с кодом, чем намереваться добавлять комментарии позже.
Комментарии не могут оправдать плохо написанный код
Комментарии не могут компенсировать отсутствие в коде подходящего выбора имени и явной логической структуры. Такой код следует переписать. Стив МакКоннелл: «Улучшите код, а затем задокументируйте его, чтобы сделать его еще понятнее».
Комментарии должны согласовываться с кодом, но делать больше, чем просто повторять код
Плохой или бесполезный комментарий только мешает читателю. Н. Шрайер: «Если код и комментарии не совпадают, то, вероятно, оба они неверны». Обычно более важно, чтобы в комментарии говорилось о том, почему или как, а не о том, что.
Комментарии должны легко читаться
Между % и текстом комментария должен быть пробел.
Комментарии должны начинаться с заглавной буквы и заканчиваться точкой.
Комментарии обычно должны иметь тот же отступ, что и операторы, на которые ссылаются
Это делается для того, чтобы комментарии не нарушали компоновку программы. Комментарии в конце строки имеют тенденцию быть загадочными, и их следует избегать, за исключением постоянных определений.
Комментарии заголовка функции должны поддерживать использование справки и поиска
help выводит первый непрерывный блок строк комментариев из файла. Сделайте это полезным.
lookfor ищет первую строку комментария всех m-файлов на пути. Попробуйте включить в эту строку вероятные поисковые слова.
В комментариях к заголовку функции должны обсуждаться особые требования к входным аргументам.
Пользователю необходимо знать, должны ли вводимые данные быть выражены в определенных единицах измерения или представляют собой определенный тип массива.
% ejectionFraction должен быть в диапазоне от 0 до 1, а не в процентах.
% elapsedTimeSeconds должен быть одномерным.
Комментарии к заголовку функции должны описывать любые побочные эффекты.
Побочные эффекты — это действия функции, отличные от присвоения выходных переменных. Типичный пример — генерация сюжета. Описания этих побочных эффектов должны быть включены в комментарии к заголовку, чтобы они отображались в распечатке справки.
Как правило, последний комментарий заголовка функции должен переформулировать строку функции
Это позволяет пользователю взглянуть на распечатку справки и увидеть использование входных и выходных аргументов.
Написание имени функции в верхнем регистре в заголовке функции является спорным. Многие другие авторы не следуют этой практике.
Его недостаток в том, что в коде имя функции обычно должно быть в нижнем регистре. В более новых версиях MATLAB имя функции, состоящее из заглавных букв, будет отображаться в нижнем регистре и жирным шрифтом в распечатке справки.
Избегайте беспорядка в справочной распечатке заголовка функции
Обычно в комментарии к началу функционального файла включаются строки об авторских правах и история изменений. Между комментариями заголовка и этими комментариями должна быть пустая строка, чтобы они не отображались в ответ на помощь.
Все комментарии должны быть написаны на английском языке
В международной среде предпочтение отдается английскому языку.
matlab – В чем разница между % и %% для комментариев?
спросил
Изменено 9 лет, 6 месяцев назад
Просмотрено 28 тысяч раз
Редактор MATLAB автоматически выделяет все содержимое после %% в той же строке выделяется жирным шрифтом.
Но в чем здесь принципиальная разница? Почему люди иногда используют %% вместо % ?
- matlab
- комментарии
С точки зрения синтаксиса оба они являются комментариями.
В редакторе Matlab Matlab анализирует %% блоков с разделителями как «разделы», которые вы можете запускать как единое целое независимо от запуска всего скрипта.
4
Знак процента ( % ) используется для комментирования строк.
Два знака процента ( %% ) имеют другое назначение: они используются для разделения вашего кода на разделы, которые можно запускать независимо. Это упрощает отладку.
0
Мне очень нравится знак двойного процента ( %% ) и я использую, насколько это возможно, по следующим причинам:
Создает блок ячеек , который может быть запущен отдельно от всего кода ( Ctrl + Введите ).
Как упоминалось в разделах, это улучшает читаемость файла и отображается в виде заголовка, если вы опубликовать свой код. Это увеличивает концентрацию, создавая желтый фон , и вы можете больше сосредоточиться на той части, над которой работаете.
Вы можете сложить код в ячейках блоков . (Сначала вы должны включить свертывание кода блоков ячеек в Preferences >> Editor/Debugger >> Code Folding >> Sections ). Это особенно полезно в больших mfiles .
Если вы заботитесь о сохранении очистить История команд Запуск кодов в блоках ячеек ( Ctrl + Ввод ) не оставляет никаких следов в Истории команд , в отличие от Оценить выбор ( F9 ), который оценивает выбранный (выделенный ) и хранит исполняемый код в истории команд .
Надеюсь, это поможет.