Публикация и совместное использование кода MATLAB
MATLAB® предоставляет опции для представления вашего кода другим. Можно опубликовать файлы кода MATLAB (.m) для создания форматированных документов или создания и совместного использования live скриптов и live функций в Live Editor.
Создание и совместное использование Live скриптов в Live Editor
Самый легкий способ создать сплоченные, четкие документы, включающие исполняемый код MATLAB, встроенный выход и форматированный текст, - использовать Live Editor. Поддерживаемые выходные форматы включают: MLX, PDF, Microsoft® Word, HTML и LaTeX. Для получения дополнительной информации см. раздел «Создание Live скриптов в Live Editor».
Публикация файлов кода MATLAB (.m)
Чтобы создать общие документы с использованием файлов кода MATLAB (.m), можно publish файлы. Публикация файла кода MATLAB создает форматированный документ, который включает ваш код, комментарии и выход. Распространенными причинами публикации кода являются обмен документами с другими для обучения или демонстрации, или для создания читаемой, внешней документации вашего кода.
Этот код демонстрирует расширение ряда Фурье для квадратной волны.
Код MATLAB с разметкой | Опубликованный документ |
|---|---|
|
|
Чтобы опубликовать код:
Создайте скрипт MATLAB или функцию. Разделите код на шаги или разделы путем вставки двух процентов знаков (
%%) в начале каждого раздела.Документируйте код путем добавления пояснительных комментариев в начале файла и внутри каждого раздела.
В комментариях в верхней части каждого раздела можно добавить разметку, которая повышает читаемость выхода. Например, код в предыдущей таблице включает следующую разметку.
Заголовки
%% Square Waves from Sine Waves%% Add an Odd Harmonic and Plot It%% Note About Gibbs PhenomenonИмя переменной курсивом
% As _k_ increases, ...Уравнение LaTeX
% $$ y = y + \frac{sin(k*t)}{k} $$Примечание
Когда у вас есть файл, содержащий текст, который имеет символы в кодировку , отличную от вашей платформы, когда вы сохраняете или публикуете файл, MATLAB отображает эти символы как искаженный текст.
Опубликуйте код. На вкладке Publish нажмите Publish.
По умолчанию MATLAB создает подпапку с именем
html, который содержит HTML и файлы для каждого графика, который создает ваш код. HTML файла включает код, форматированные комментарии и выход. Также можно публиковать в других форматах, таких как PDF файлов или Microsoft PowerPoint® презентации. Дополнительные сведения о публикации в другие форматы см. в разделе «Задание выходного файла».В Online™ MATLAB, чтобы разрешить MATLAB автоматически открывать выходные окна при публикации, включите всплывающие окна в веб-браузере.
После публикации кода можно поделиться папкой, содержащей опубликованные файлы. Для получения дополнительной информации см. раздел «Совместное использование папок в MATLAB». В MATLAB Online можно также сделать результаты общедоступными, скопировав опубликованные файлы из html папка в Published папка. Затем можно использовать URL-адрес формы https ://matlab.mathworks.com/users (для HTML) или / userid/ Опубликовано/ filename/index.htmlhttps ://matlab.mathworks.com/users (для PDF) для совместного использования файлов./ userid/ Опубликовано/ foldername/ filename.pdf
Пример кода, который появляется на предыдущем рисунке, является частью установленной документации. Вы можете просмотреть код в редакторе, запустив эту команду:
edit(fullfile(matlabroot,'help','techdoc','matlab_env', ... 'examples','fourier_demo2.m'))
Добавление справки и создание документации
Можно добавить помощь в код, вставив комментарии в начале файла кода MATLAB. MATLAB отображает комментарии справки при вводе help
file_name в Командном окне. Для получения дополнительной информации см. раздел «Добавление справки по программе».
Можно также создать собственные темы документации MATLAB для просмотра из браузера MATLAB Help или в Интернете. Для получения дополнительной информации см. Раздел «Отображение пользовательской документации»