Exponenta Banner

документ

Страница с описанием в Браузере документации

свернуть все на странице

Синтаксис

документ
doc name

Описание

doc открывает Браузер документации. Если Браузер документации уже открыт, но не видим, то doc приносит его к переднему плану и открывает новую вкладку.

пример

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

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

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

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

Примеры

свернуть все

Скрипт Open Live Script

Отобразите страницу с описанием для функции abs. 

doc abs

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

Скрипт Open Live Script

Отобразите страницу с описанием для класса handle. 

doc handle

Отобразите страницу с описанием для метода findobj в классе handle. 

doc handle.findobj

Отобразите страницу с описанием для класса Map в пакете containers. 

doc containers.Map
Скрипт Open Live Script

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

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; вместо этого, используйте ссылки на странице ссылки класса.

Советы

  • Для доступа сторонняя или пользовательская документация откройте Браузер документации и перейдите к странице домашней страницы документации. Затем внизу страницы нажмите Supplemental Software.

Смотрите также

|

Темы

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

Была ли эта тема полезной?
Документация MATLAB
Поддержка