Попробуйте этот другой раздел в официальной документации. Это более тщательно. MATLAB> Руководство пользователя> Инструменты рабочего стола и среда разработки> Настройка справки и демонстраций> Предоставление собственной справки и демонстраций. Здесь описывается как простой текст справки, так и создание отдельных файлов справки HTML.
Вот форматирование справочного текста, которое я нашел и нашел полезным.
function foo(x,y,z)
%FOO One-line description goes here
%
% foo(x,y,z)
%
% Multi-line paragraphs of descriptive text go here. It's fine for them to
% span lines. It's treated as preformatted text; help() and doc() will not
% re-wrap lines. In the editor, you can highlight paragraphs, right-click,
% and choose "Wrap selected comments" to re-flow the text.
%
% More detailed help is in the <a href="matlab: help foo>extended_help">extended help</a>.
% It's broken out like this so you can keep the main "help foo" text on
% a single screen, and then break out obscure parts to separate sections.
%
% Examples:
% foo(1,2,3)
%
% See also:
% BAR
% SOMECLASS/SOMEMETHOD
disp(x+y+z);
function extended_help
%EXTENDED_HELP Some additional technical details and examples
%
% Here is where you would put additional examples, technical discussions,
% documentation on obscure features and options, and so on.
error('This is a placeholder function just for helptext');
- Первая строка после сигнатуры функции называется «линией H1». Это должна быть всего одна строка, чтобы она правильно подбиралась contentrpt (), который может автоматически генерировать файл Contents.m из текста помощи в ваших функциях
- Имя функции в строке H1 - все заглавные буквы, независимо от фактической прописной буквы имени функции в подписи
- Дело имеет значение для "Смотрите также". Я не уверен, какие все дела работают; это точно.
- Имена функций после «Смотри также:» - все заглавные. Имена методов уточнены; Я думаю, что имена методов в том же классе, что и текущий метод, могут быть безусловными.
Все, что находится между строкой H1 и «Примеры:» - это просто обычное форматирование, которое я считаю читабельным; help () не обрабатывает это специально.
Вы можете использовать ограниченную форму гиперссылок в справке. В частности, вы можете использовать гиперссылки для вызова произвольных команд Matlab и указывать на другие разделы справочного текста, вызывая его help (). Вы можете использовать это, чтобы указать на любую функцию; «function> subfunction» - это просто синтаксис для адресации подфункций в вызовах help (). К сожалению, поскольку в эти гиперссылки необходимо добавить «help» или «doc», он работает только в той или иной форме представления. Было бы лучше, если бы существовала форма гиперссылки с прямым текстом справки.