Exponenta Banner
exponenta event banner

помощь

Справка по функциям в окне команд

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

Синтаксис

имя справки
помощь

Описание

пример

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 is a folder.

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

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

Совет

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

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

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

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

См. также

| | | | |

Темы

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

Документация MATLAB

Поддержка