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
は関数と複数のメソッドの名前であるため、ヘルプ テキストには同じ名前のメソッドのリストへのリンクが含まれます。
handle
クラスの delete
メソッドのヘルプを要求します。
help handle/delete
パッケージ、クラスおよびメソッドのヘルプの表示
containers
パッケージ、Map
クラス、および isKey
メソッドのヘルプを表示します。
help containers help containers.Map help containers.Map.isKey
必ずしもすべてのパッケージ、クラスおよび関連メソッドまたはイベントで完全な指定が必要であるとは限りません。たとえば、MException
クラスの throwAsCaller
メソッドのヘルプ テキストを表示します。
help throwAsCaller
変数のヘルプの表示
datetime
型の変数のヘルプを表示します。
t = datetime
help t
t
の型は datetime
なので、help
コマンドは datetime
クラスのヘルプ テキストを表示します。
Day
(datetime
クラスのメソッド) のヘルプを要求します。
help t.Day
フォルダー内の関数のヘルプの表示
部分的なパスを指定することによりフォルダー matlabroot
/toolbox/matlab/timefun
内のすべての関数をリストします。
help timefun
入力引数
name
— 機能名
文字ベクトル | string スカラー
関数、メソッド、クラス、ツールボックス、変数などの機能名。文字ベクトルまたは string スカラーとして指定します。name
は演算子記号 (+
) などにすることもできます。
name
が変数の場合、help
はその変数のクラスのヘルプ テキストを表示します。
クラスのメソッドのヘルプを取得するには、クラス名とメソッド名をピリオドで区切って指定します。たとえば、classname
クラスの methodname
メソッドのヘルプを取得するには、help classname.methodname
と入力します。
一部のクラスとその他のパッケージ化項目では、パッケージ名の指定が必要になります。イベント、プロパティ、一部のメソッドでは、クラス名を指定しなければなりません。名前の要素をピリオドで区切ります。たとえば、classname
クラスの propertyname
プロパティのヘルプを取得するには、classname.propertyname
と入力します。packagename
パッケージの classname
クラスのヘルプを取得するには、「packagename.methodname
」と入力します。packagename
パッケージの classname
クラスの methodname
メソッドのヘルプを取得するには、「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 コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)