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