Programming and Data Types

プログラムのヘルプ

M-ファイルの先頭にヘルプテキスト部分を含めることによって、プログラムに対するユーザ情報を与えることができます。これは、関数定義ラインから始まり、最初のブランク行で終わります。ヘルプテキストの各ラインは、コメントキャラクタ(%)で始まらなければなりません。MATLABは、つぎのようにタイプするとこの情報を表示します。

help m-file_name

特殊なファイル名Contents.mを使ってファイルを作成することにより、ディレクトリ内にあるディレクトリ全体に対するヘルプエントリを作成することもできます。このファイルは、コメントラインのみを含まなければなりません。つまり、各ラインは、パーセント記号で始まらなければなりません。MATLABは、つぎのようにタイプすると、Contents.mファイルのラインを表示します。

help directory_name

ディレクトリがContents.mファイルを含まない場合は、help directory_nameとタイプすると、ディレクトリ内の各M-ファイルに対して最初のヘルプライン(Hライン)を表示します。

M-ファイルとは?

M-ファイルの作成: テキストエディタへのアクセス