help

Помощь по функциям в Командном окне

Синтаксис

Описание

пример

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

Примечание

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

help отображает содержимое, относящееся к вашим предыдущим действиям.

Примеры

свернуть все

Отображение справки по MATLAB® delete функция.

help delete
delete Delete file or graphics object.
    delete file_name  deletes the named file from disk.  Wildcards
    may be used.  For example, delete *.p deletes all P-files from the
    current directory.
...

Поскольку delete - имя функции и нескольких методов, текст справки включает ссылку на список методов с таким же именем.

Запросите помощь для delete метод handle класс.

help handle/delete

Отобразите справку по containers пакет, Map класса, и isKey способ.

help containers
help containers.Map
help containers.Map.isKey

Не все пакеты, классы и связанные методы или события требуют полной спецификации. Для примера отобразите текст справки для throwAsCaller метод MException класс.

help throwAsCaller

Отобразите справку по переменной типа datetime.

t = datetime
help t

Потому что t имеет тип datetime, help команда отображает текст справки для datetime класс.

Запросить помощь в Day, метод datetime класс.

help t.Day

Перечислите все функции в папке matlabroot/toolbox/matlab/timefun путем определения частичного пути.

help timefun

Входные параметры

свернуть все

Имя функциональности, такое как имя функции, метода, класса, тулбокса или переменной, заданное как вектор символов или строковый скаляр. name также может быть символом оператора (например +).

Если name является переменной, help отображает текст справки для класса этой переменной.

Чтобы получить справку для метода класса, укажите имя класса и метода, разделенные точкой. Для примера, чтобы получить помощь для methodname метод classname класс, тип help classname.methodname.

Некоторые классы и другие упакованные элементы требуют, чтобы вы задали имя пакета. События, свойства и некоторые методы требуют, чтобы вы задали имя класса. Разделите компоненты имени точками. Например, чтобы получить помощь для propertyname свойство classname класс, тип classname.propertyname. Чтобы получить помощь для classname класс в packagename пакет, тип packagename.methodname. Чтобы получить помощь для methodname метод classname класс в packagename пакет, тип packagename.classname.methodname.

Если name появляется в нескольких папках на путь поиска файлов MATLAB, help отображает текст справки для первого образца name найден в пути поиска файлов.

Если name перегружен, help отображает ссылку на список методов с таким же именем.

Если name задает имя или частичный путь к папке:

  • Если папка содержит непустой Contents.m файла, help функция отображает файл. Contents.m содержит список программных файлов MATLAB в папке и их описания.

  • Если папка содержит пустую Contents.m файла, help функция отображает name является папкой.

  • Если папка не содержит Contents.m файла, help функция приводит список первых линий текста справки для каждого программного файла в папке.

  • Если name - имя папки и другого элемента в пути поиска файлов MATLAB (например, метода, класса, тулбокса или переменной); help функция отображает связанный текст элемента в пути поиска файлов и ссылку для отображения текста справки для папки.

Совет

  • Чтобы предотвратить прокрутку длинных описаний с экрана до того, как вы успеете их прочитать, введите more on, а затем введите help оператор.

  • Чтобы идентифицировать имя пакета для класса, создайте образец класса, а затем вызовите class(obj).

Альтернативная функциональность

Просмотрите более обширную справку с помощью doc команда или браузер функций.

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