このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。
この例では、記述したプログラムにヘルプを追加する方法を説明します。ヘルプ テキストは、帮助
関数を使用するときにコマンド ウィンドウに表示されます。
プログラムの最初にコメントを挿入してヘルプ テキストを作成します。プログラムに関数が含まれている場合、ヘルプ テキストは関数の定義行 (作用
キーワードのある行) のすぐ下に配置します。関数に论据
ブロックが含まれている場合、ヘルプ テキストは论据
ブロックのすぐ下に配置することもできます。
たとえば、ヘルプ テキストを含む関数をaddme.m
というファイル名で作成します。
作用c=地址(a,b)%ADDME将两个值相加。%C=ADDME(A)将A添加到自身。%%C=相加(A,B)将A和B相加。%%另见SUM,PLUS。转换函数输入变量数案例2c=a+b;案例1 c=a+a;否则c=0;终止
コマンド ラインに帮帮我
と入力すると、以下のようなヘルプ テキストがコマンド ウィンドウに表示されます。
地址将两个值相加=地址(A) 将A添加到自身。C=地址(A,B)将A和B相加。另请参见总和,加.
最初のヘルプ テキスト行 (H1行と呼ばれることが多い) には、通常、プログラム名と簡単な説明が含まれます。[現在のフォルダー] ブラウザーと関数帮助
および寻找
は、H1行を使用してプログラムについての情報を表示します。
%另见
で始まる行のヘルプ テキストの最後に関数名を含めることにより、另见
リンクを作成します。これらの関数が検索パス上か現在のフォルダー内にある場合は、帮助
コマンドを使用すると、これらの関数名がヘルプへのハイパーリンクとして表示されます。検索パスにない場合、帮助
は、ヘルプ テキストに表示される関数名を出力します。
ヘルプ テキストに、网状物サイトへのハイパーリンクを (网址の形式で) 含めることができます。HTMLアンカー要素を含めてハイパーリンクを作成します。アンカー内で、
matlab:
ステートメントを使用して网状物
コマンドを実行します。以下に例を示します。
%有关更多信息,请参见//www.tatmou.com“)”>MathWorks网站。
空白行 (%
なし) でヘルプ テキストを終了します。ヘルプ システムでは、ヘルプ テキスト ブロックの後にあるコメント行は無視されます。
メモ
同じ名前をもつ複数のプログラムがある場合、帮助
コマンドは関数の優先順位で説明されているルールを適用して表示するヘルプ テキストを決定します。ただし、プログラムが 迈斯沃克®関数と同じ名前である場合は、コンテキスト メニューの[選択のヘルプ]オプションには常に 数学作品関数のドキュメンテーションが表示されます。