Main Content

ライブ関数のヘルプの追加

記述するライブ関数についてのヘルプを提供することができます。ヘルプ テキストは、help コマンドを使用するとコマンド ウィンドウに表示されます。doc コマンドを使用して、ヘルプ テキストを別のブラウザーに表示することもできます。

ヘルプ テキストを作成するには、ファイルの先頭にある関数定義行 (function キーワードがある行) の直前にテキストを挿入します。

たとえば、次のコードで addme.mlx というライブ関数を作成します。

function c = addme(a,b)

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end
関数について説明するヘルプ テキストを追加します。

addme live function with help text above the code, including the function's purpose, supported syntaxes, and related functions

コマンド ウィンドウで help addme と入力すると、ヘルプ テキストが表示されます。

Command Window with the help text for the addme live function displayed

ヘルプ テキストの最初の行 (H1 行と呼ばれることが多い) には、通常、関数の簡単な説明が含まれています。関数のヘルプを表示する際、MATLAB® は最初に関数の名前を表示し、続けて H1 行を表示します。次に MATLAB は関数の構文を表示します。最後に MATLAB は、残りのすべてのヘルプ テキストを表示します。

"参考" リンクを追加するには、See also という語句で始まり、その後に関数名のリストが続くテキスト行をヘルプ テキストの最後に追加します。関数が検索パス上か現在のフォルダー内にある場合は、help コマンドを使用すると、これらの各関数名がヘルプへのハイパーリンクとして表示されます。検索パスにない場合、help は、ヘルプ テキストに表示される関数名を出力します。

メモ

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

ヘルプ ブラウザーに表示されるドキュメンテーションを改善するため、テキストに書式を設定してハイパーリンク、イメージ、数式、およびコード例を追加することができます。たとえば、関数 addme で、H1 行を選択して [ライブ エディター] タブで [標準] テキスト スタイルを [タイトル] に変更します。次に、カーソルを 2 番目の構文説明の終わりに合わせ、[挿入] タブに移動して [式] を選択します。c = a + b という式を入力して Esc キーを押します。最後に [挿入] タブで、[コード例][MATLAB] を選択して 2 つの例を追加します。ライブ エディターでのファイルの書式設定の詳細については、ライブ エディターでのテキストの書式設定を参照してください。

addme live function with formatted help text above the code, including a title, a formatted equation, and code examples

ヘルプ テキストを別のブラウザーに表示するには doc コマンドを使用します。

Separate browser showing the formatted help text for the addme live function

また、ファイルの先頭にコメントを挿入することで、ライブ関数にヘルプを追加することもできます。help コマンドと doc コマンドを使用すると、ファイルの先頭のコメントがヘルプ テキストとして表示されます。これは、ファイルの先頭のテキストが表示されるのと同様です。コメントを追加したヘルプの追加の詳細については、プログラムへのヘルプの追加を参照してください。

参考

関連するトピック