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

プログラムへのヘルプの追加

この例では、記述したプログラムにヘルプを追加する方法を説明します。ヘルプ テキストは、help 関数を使用するときにコマンド ウィンドウに表示されます。

プログラムの最初にコメントを挿入してヘルプ テキストを作成します。プログラムに関数が含まれている場合、ヘルプ テキストは関数の定義行 (function キーワードのある行) のすぐ下に配置します。

たとえば、ヘルプ テキストを含む関数を addme.m というファイル名で作成します。

function c = addme(a,b)
% ADDME  Add two values together.
%   C = ADDME(A) adds A to itself.
%
%   C = ADDME(A,B) adds A and B together.
%
%   See also SUM, PLUS.

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end

コマンド ラインに help addme と入力すると、以下のようなヘルプ テキストがコマンド ウィンドウに表示されます。

addme  Add two values together.
    C = addme(A) adds A to itself.

    C = addme(A,B) adds A and B together.
 
    See also sum, plus.

最初のヘルプ テキスト行 (H1 行と呼ばれることが多い) には、通常、プログラム名と簡単な説明が含まれます。[現在のフォルダー] ブラウザーと関数 help および lookfor は、H1 行を使用してプログラムについての情報を表示します。

% See also で始まる行のヘルプ テキストの最後に関数名を含めることにより、See also リンクを作成します。これらの関数が検索パス上か現在のフォルダー内にある場合は、help コマンドを使用すると、これらの関数名がヘルプへのハイパーリンクとして表示されます。検索パスにない場合、help は、ヘルプ テキストに表示される関数名を出力します。

ヘルプ テキストに、Web サイトへのハイパーリンクを (URL の形式で) 含めることができます。HTML <a></a> アンカー要素を含めてハイパーリンクを作成します。アンカー内で、matlab: ステートメントを使用して web コマンドを実行します。以下に例を示します。

% For more information, see <a href="matlab: 
% web('https://www.mathworks.com')">the MathWorks Web site</a>.

空白行 (% なし) でヘルプ テキストを終了します。ヘルプ システムでは、ヘルプ テキスト ブロックの後にあるコメント行は無視されます。

メモ

同じ名前をもつ複数のプログラムがある場合、help コマンドは 関数の優先順位で説明されているルールを適用して表示するヘルプ テキストを決定します。ただし、プログラムが MathWorks® 関数と同じ名前である場合は、コンテキスト メニューの [選択のヘルプ] オプションには常に MathWorks 関数のドキュメンテーションが表示されます。

参考

|

関連するトピック