help

コマンド ウィンドウでの関数のヘルプ

ページ内をすべて折りたたむ

構文

help name
help

説明

help name は、関数、メソッド、クラス、ツールボックス、変数、名前空間など、name で指定された機能のヘルプ テキストを表示します。

例

help は、以前のアクションに関連する内容を表示します。

例

すべて折りたたむ

MATLAB® 関数 delete のヘルプを表示します。

help delete
delete - Delete files or objects
    This MATLAB function deletes filename from disk, without requesting
    verification.

    Syntax
      delete filename
      delete filename1 ... filenameN
      delete ___ ResolveSymbolicLinks=tf
      delete(obj)delete Delete file or graphics object.
...

delete は関数と複数のメソッドの名前であるため、ヘルプ テキストには同じ名前のメソッドのリストへのリンクが含まれます。handle クラスの delete メソッドのヘルプを要求します。

help handle/delete
handle/delete - Delete handle object
    This MATLAB function deletes the handle object.

    Syntax
      delete(H)
...

containers 名前空間、Map クラス、および isKey メソッドのヘルプを表示します。

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

必ずしもすべての名前空間、クラス、および関連メソッドまたはイベントで完全な指定が必要であるとは限りません。たとえば、MException クラスの throwAsCaller メソッドのヘルプ テキストを表示します。

help throwAsCaller

datetime 型の変数のヘルプを表示します。t の型は datetime なので、help コマンドは datetime クラスのヘルプ テキストを表示します。

t = datetime;
help t
--- help for datetime ---

 datetime - Arrays that represent points in time
    The datetime data type represents points in time, such as August 24,
    2020, 10:50:30 a.m.

    Creation
...

Day (datetime クラスのメソッド) のヘルプを要求します。

help t.Day
--- help for datetime/Day ---

 datetime/Day - Day-of-month number
  numeric array
...

部分的なパスを指定することによりフォルダー matlabroot/toolbox/matlab/timefun 内のすべての関数をリストします。

help timefun
Timing functions.
    cputime          - CPU time in seconds.
    tic              - Start stopwatch timer.
    toc              - Stop stopwatch timer.
    etime            - Elapsed time.
    pause            - Wait in seconds.
...

入力引数

すべて折りたたむ

関数、メソッド、クラス、ツールボックス、変数などの機能名。文字ベクトルまたは string スカラーとして指定します。name は演算子記号 (+) などにすることもできます。

name が変数の場合、help はその変数のクラスのヘルプ テキストを表示します。

クラスのメソッドのヘルプを取得するには、クラス名とメソッド名をピリオドで区切って指定します。たとえば、classname クラスの methodname メソッドのヘルプを取得するには、help classname.methodname と入力します。

一部のクラスとその他の名前空間項目では、名前空間名の指定が必要になります。イベント、プロパティ、一部のメソッドでは、クラス名を指定しなければなりません。名前の要素をピリオドで区切ります。たとえば、classname クラスの propertyname プロパティのヘルプを取得するには、classname.propertyname と入力します。namespacename 名前空間の classname クラスのヘルプを取得するには、「namespacename.methodname」と入力します。namespacename 名前空間の classname クラスの methodname メソッドのヘルプを取得するには、「namespacename.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) を呼び出します。

バージョン履歴

R2006a より前に導入

参考

| | | | |

トピック