最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

ヘルプのあるプログラムの確認

ヘルプ テキストをもつプログラム ファイルを確認するには、ヘルプ レポートを使用します。

ヘルプ レポートで、例や See Also 行など検索する一連のヘルプ コンポーネントを指定します。検索された各ファイルに対して、MATLAB® は見つかったコンポーネントのヘルプ テキストを表示します。それ以外の場合、MATLAB はコンポーネントがないことを示すメッセージを強調表示します。

ヘルプ レポートを生成するには、現在のフォルダー ブラウザーでチェックするフォルダーまで移動し、 をクリックして [レポート][ヘルプ レポート] を選択します。ヘルプ レポートは MATLAB Web ブラウザーで表示されます。

メモ

パスが UNC (Universal Naming Convention) パス名である場合、すなわちパスが \\ で始まる場合は、レポートを実行できません。代わりに、システム上の実際のハード ドライブまたはマッピングされているネットワーク ドライブを使用します。

次の表では、ヘルプ レポートで使用できるオプションを説明します。

ヘルプ レポート オプション説明

クラス メソッドの表示

メソッドをレポートに含めます。このオプションを選択しない場合、レポートにクラスの結果は含まれますが、クラス定義ファイル内のメソッドの結果は含まれません。

すべてのヘルプを表示

各ファイルで見つかったすべてのヘルプ テキストを表示します。"説明" などの個別のヘルプ コンポーネントも選択する場合、ヘルプ テキストは各ファイルのレポートに 2 回 (全体のヘルプ テキストで 1 回、コンポーネントで 1 回) 表示されます。

プログラムの名前が MATLAB 検索パス上にある他のプログラムの名前と同じ場合、help コマンドはそれらの "オーバーロードされた" 項目のリストを生成し、その項目のヘルプへのリンクを自動的に追加します。

説明

ファイル内の最初の空でないコメント行が検索されます。この行は H1 行と呼ばれることもあります。

ヘルプ テキストの例が検索されます。ヘルプ レポートは、example という 1 語のみが含まれるヘルプ行を検索します。大文字小文字は区別しません。レポートはその行と後続の空でないコメント行を、先頭に行番号を付けて表示します。

参考

See also で始まるヘルプの行が検索されます。レポートはテキストと最初の行番号を表示します。

See also の後にリストされているプログラムが検索パス上にある場合、help コマンドはそのプログラムのヘルプへのハイパーリンクを生成します。ヘルプ レポートは、See also 行のプログラムがパス上にないときもその旨を示します。

Copyright

ファイル内の Copyright で始まるコメント行が検索されます。copyright 行がある場合、レポートは終了年が現在であるかどうかもチェックします。日付チェックでは、copyright 行に単一年 (たとえば 2012) またはスペースなしの年の範囲 (たとえば 2001-2012) のどちらかが含まれていることが必要になります。

ファイルの作成年から現在の年までの範囲を含めることをお勧めします。

関連するトピック