Опубликуйте и совместно используйте код 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®. Для получения дополнительной информации о публикации к другим форматам смотрите, Задают Выходной файл.В 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/foldernameFileName .pdf
Пример кода, который появляется на предыдущем рисунке, является частью установленной документации. Можно просмотреть код в Редакторе путем выполнения этой команды:
edit(fullfile(matlabroot,'help','techdoc','matlab_env', ... 'examples','fourier_demo2.m'))
Добавьте справку и создайте документацию
Можно добавить справку к коду путем вставки комментариев в начале файла кода MATLAB. MATLAB отображает комментарии справки, когда вы вводите help
file_name в Командном окне. Для получения дополнительной информации смотрите, Добавляет Справка для Вашей Программы.
Также можно создать собственные темы документации MATLAB для просмотра от Браузера документации MATLAB или сети. Для получения дополнительной информации см. Отображение пользовательской документации