exponenta event banner

доктор

Справочная страница в браузере справки

Описание

doc открывает обозреватель справки. Если браузер справки уже открыт, но не виден, то doc выводит его на передний план и открывает новую вкладку.

пример

doc name отображает документацию по функциям, указанным в name, например, функция, класс или блок.

  • Если name соответствует справочной странице MathWorks ®, затемdoc отображает страницу в браузере справки. doc не отображает документацию стороннего или пользовательского HTML.

  • Если name не соответствует справочной странице, то doc поиск текста справки в файле с именем name.m или name.mlx. Если текст справки доступен, doc отображает его в браузере справки.

  • Если name не соответствует справочной странице и нет связанного текста справки, то doc выполняет поиск в документации для name и отображает результаты поиска в браузере справки.

Примеры

свернуть все

Отображение справочной страницы для abs функция.

doc abs

Несколько продуктов включают различные версии abs. Если настройки справки поддерживают отображение документации по этим продуктам, то в браузере справки отображается MATLAB ®abs справочная страница и сообщение со ссылками на другие версии abs. Это сообщение появляется в верхней части страницы.

Отображение справочной страницы для handle класс.

doc handle

Отображение справочной страницы для findobj метод в handle класс.

doc handle.findobj

Отображение справочной страницы для Map класс в containers пакет.

doc containers.Map

Отображение форматированного текста справки для пользовательского класса.

Файл класса sads.m - это пример файла, в котором показано, как создать класс. Добавьте папку-пример к пути и запросите документацию для sads.

addpath(...
   fullfile(matlabroot,'help','techdoc','matlab_env',...
   'examples'))
doc sads

Просмотр справки для steer способ sads класс. Поскольку текст справки соответствует правилам MATLAB, MATLAB форматирует отображение в браузере.

doc sads.steer

Входные аргументы

свернуть все

Имя функциональности, такой как функция, класс или блок, указанное как символьный вектор. Альтернативно, символ оператора.

Для некоторых классов и других упакованных элементов необходимо указать имя пакета. События, свойства и некоторые методы требуют указания имени класса. Разделите компоненты имени точками, например:

doc className.name
doc packageName.name
doc packageName.className.name

Методы для некоторых классов недоступны с помощью doc команда; вместо этого используйте ссылки на странице ссылки на класс.

Совет

  • Чтобы получить доступ к сторонней или пользовательской документации, откройте браузер справки и перейдите на домашнюю страницу документации. Затем в нижней части страницы щелкните Дополнительное программное обеспечение.

Представлен до R2006a