MATLAB ® предоставляет возможности для представления кода другим пользователям. Вы можете опубликовать файлы кода MATLAB (.m) для создания отформатированных документов или создания и совместного использования сценариев и функций live в редакторе Live.
Самый простой способ создания согласованных совместно используемых документов, включающих исполняемый код MATLAB, встроенные выходные данные и форматированный текст, - это использование Live Editor. Поддерживаемые форматы вывода: MLX, PDF, Microsoft ® Word, HTML и LaTeX. Дополнительные сведения см. в разделе Создание сценариев в интерактивном редакторе.
.m)Для создания совместно используемых документов с использованием файлов кода MATLAB (.m), можно опубликовать файлы. При публикации файла кода MATLAB создается форматированный документ, включающий код, комментарии и выходные данные. Распространенными причинами публикации кода являются обмен документами с другими пользователями для обучения или демонстрации или создание читаемой внешней документации кода.
Этот код демонстрирует расширение серии Фурье для квадратной волны.
Код MATLAB с разметкой | Опубликованный документ |
|---|---|
|
|
Чтобы опубликовать код, выполните следующие действия.
Создайте сценарий или функцию MATLAB. Разделите код на шаги или разделы, вставив два процентных знака (%%) в начале каждого раздела.
Документирование кода путем добавления пояснительных комментариев в начале файла и в каждом разделе.
В комментариях в верхней части каждого раздела можно добавить разметку, которая повышает читаемость выходных данных. Например, код в предыдущей таблице включает следующую разметку.
Названия |
|
Имя переменной выделено курсивом |
|
Уравнение LaTeX |
|
Примечание
При наличии файла, содержащего текст с кодировкой, отличной от кодировки платформы, при сохранении или публикации файла MATLAB отображает эти символы как искаженный текст.
Опубликуйте код. На вкладке Публикация (Publish) щелкните Опубликовать (Publish).
По умолчанию MATLAB создает подпапку с именем html, который содержит HTML-файл и файлы для каждого создаваемого кода. HTML-файл содержит код, форматированные комментарии и выходные данные. Кроме того, можно публиковать в других форматах, таких как PDF-файлы или презентации Microsoft PowerPoint ®. Дополнительные сведения о публикации в других форматах см. в разделе Указание выходного файла.
В MATLAB Online™, чтобы позволить MATLAB автоматически открывать окна вывода при публикации, включите всплывающие окна в веб-браузере.
После публикации кода можно открыть общий доступ к папке, содержащей опубликованные файлы. Дополнительные сведения см. в разделе Общий доступ к папкам в MATLAB. В MATLAB Online можно также сделать результаты общедоступными, скопировав опубликованные файлы из html в папку Published папка. Затем можно использовать URL-адрес формы https://matlab.mathworks.com/users/ (для HTML) или userid/Published/filename/index.htmlhttps://matlab.mathworks.com/users/ (для PDF) для совместного использования файлов.userid/Published/foldername/filename.pdf
Пример кода, показанный на предыдущем рисунке, является частью установленной документации. Чтобы просмотреть код в редакторе, выполните следующую команду:
edit(fullfile(matlabroot,'help','techdoc','matlab_env', ... 'examples','fourier_demo2.m'))
В код можно добавить справку, вставив комментарии в начале файла кода MATLAB. MATLAB отображает комментарии справки при вводе help
file_name в окне команд. Дополнительные сведения см. в разделе Добавление справки для программы.
Можно также создать собственные разделы документации MATLAB для просмотра в браузере справки MATLAB или в Интернете. Дополнительные сведения см. в разделе Отображение пользовательской документации
