Exponenta Banner

справка

Помогите для функций в Командном окне

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

Синтаксис

help name
справка

Описание

пример

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 methodName .

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

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

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

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

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

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

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

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

Советы

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

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

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

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

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

| | | | |

Темы

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

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