doc

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

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

Синтаксис

doc
doc name

Описание

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

пример

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

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

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

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

Примеры

свернуть все

Открыть Live Script

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

doc abs

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

Открыть Live Script

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

doc handle

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

doc handle.findobj

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

doc containers.Map
Открыть 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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте