Разметка MATLAB для doc-страницы - PullRequest
3 голосов
/ 22 февраля 2011

Какие есть ресурсы для объяснения того, как писать комментарии MATLAB в правильном формате для отображения с использованием 'doc' (то есть браузера справки).

В частности, я пишу класс и будукак справочная документация, похожая на собственную MATLAB.Я сосредотачиваюсь на практическом - например, документирование различных способов вызова функции.Я не смог найти никакой документации о том, какую разметку использовать в комментариях для достижения этой цели.

(В качестве дополнительного бонуса я бы хотел, чтобы всплывающие подсказки автозаполнения для функций класса отображали что-то значимое, а неMyFunction(MyClass object...) - но на данном этапе это становится слишком конкретным! Я переспрошу, если это не произойдет, как только я получу некоторую документацию)

1 Ответ

3 голосов
/ 23 февраля 2011

Попробуйте это:

Справка Matlab / Руководства пользователя / Инструменты рабочего стола и среда разработки / Помощь по настройке и демонстрация / Предоставление собственной справки и демонстрации

Надеюсь, это поможет.

Edit: Похоже, что он изменился в 2012a:

Справка Matlab / Руководства пользователя / Основы программирования / Разработка программного обеспечения / Создание справки и демонстраций / Добавление справки для ваших программных файлов

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...