MATLAB Function Reference

help

コマンドウインドウにMATLAB関数のヘルプを表示

表示

help
help /
help function
help toolbox/
help toolbox/function

詳細

help は、コマンドウインドウにすべての基本的なヘルプトピックすべてをリストします。各メインのヘルプトピックは、MATLAB のサーチパス上のディレクトリ名に対応します。

help / は、すべての演算、特殊キャラクタをその説明と共にリストします。

help function は、コマンドウインドウ内に、function に関する M-ファイルヘルプ に関する簡単な説明とシンタックスを表示しています。function が多重定義でない場合、help は、サーチパス上で最初に見つかる function に関する M-ファイルヘルプを表示します。そして、多重関数を表示します。

help toolbox/ は、指定したディレクトリ toolbox の目次ファイルを表示します。ここでは、ディレクトリのフルパス名を与える必要がありません。すなわち、最後の要素、または、最後からいくつかの要素で十分です。

help toolbox/function は、指定した toolbox に属する function に関する M-ファイルヘルプを表示します。

注意    コマンドウインドウに表示される M-ファイルヘルプは、関数や変数に関しては大文字で表示され、テキストの残りの部分から目立つようにしています。しかし、MATLAB は、小文字と大文字の区別をし、実際には、関数名は常に小文字を使っているので、関数名を入力する場合は、小文字を使ってください。

注意

ユーザ自身の M-ファイル用のオンラインヘルプの作成

MATLAB 自身と同様に MATLAB ヘルプシステムは、非常に拡張性をもっています。MATLAB の M-ファイルやツールボックスが使用する方法を使って、ユーザ自身の M-ファイルとツールボックスに関するヘルプ記述を書き込むことができます。

help 関数は、MATLAB のサーチパス上の各ディレクトリの中のコンテンツファイルの最初のライン(H1 ライン)を表示することにより、すべてのヘルプトピックをリストします。コンテンツファイルは、各ディレクトリの中で、Contents.m と名付けられた M-ファイルです。

help topic と入力して、対象のディレクトリの中に位置する Contents.m ファイルの中のコメントリストを表示します。コンテンツファイルが存在しない場合、help は、ディレクトリ内のファイルすべての H1 ラインを表示します。ここで、topic は、ディレクトリ名とします。

help topic と入力して、M-ファイル topic.mの中の最初の部分のコメントラインを表示することで、関数に関するヘルプを表示します。ここで、topic は、関数名とします。

ファイルの2行目(スクリプトの場合は、1行目)から始まる、1行、または、連続する複数行にテキストを入力することにより、ユーザ自身の M-ファイルに関する自身のオンラインヘルプを作成できます。たとえば、M-ファイル angle.m の要約版は、つぎのものを含んでいます。

function p = angle(h)
% ANGLE Polar angle.
% ANGLE(H) は、複素要素をもつ行列の位相角を戻します。
% 大きさは、ABS を使ってください。単位は、ラジアンです。
p = atan2(imag(h),real(h));

help angle を実行すると、ライン番号2、3、4が表示されます。これらのラインは、コメントラインとして連続している最初のブロックです。ヘルプシステムは、M-ファイルの中で、実行可能なステートメント、ブランクラインの後の最初のブロック以外のコメントを無視します。

M-ファイルの中の最初のコメント(H1 ライン) は、特別なものです。これには、関数名や関数の簡単な記述が含まれています。関数lookfor は、探索し、そのラインを表示し、help は、Contents.m ファイルに含まれないディレクトリの中のラインを表示します。

ユーザ自身の M-ファイルディレクトリに関するコンテンツファイルを作成

Contents.m ファイルは、MATLAB ソフトウエアと共に含まれている各 M-ファイルディレクトリについて用意されています。ユーザが、自身のM-ファイルを保存したディレクトリを作成する場合、それらに対しても、Contents.m ファイルを作成することをお勧めします。それを行うためには、既に用意されている Contents.m ファイルを参考にすると簡単です。

例題

つぎのように、入力すると

help datafun

datafun ディレクトリに対するヘルプを表示します。

また、つぎのように入力すると

help fft

関数 fft のヘルプを表示します。

ユーザが長いヘルプ記述を読む場合に、長さのために、スクリーンがスクロールする必要がある場合、more on を入力し、その後で、help 関数名 を入力してください。

参考

doc, helpbrowser, helpwin, lookfor, more, partialpath, path, what, which

hdf

helpbrowser