Main Content

doc

ヘルプ ブラウザーのリファレンス ページ

説明

doc は、ヘルプ ブラウザーを開きます。ヘルプ ブラウザーが既に開かれているが表示されていない場合、doc により前面に移動され新しいタブが開かれます。

doc name は、関数、クラス、ブロックなど、name で指定された機能のドキュメンテーションを表示します。

  • name に対応する MathWorks® のリファレンス ページがある場合、doc はヘルプ ブラウザーにそのページを表示します。doc コマンドではサードパーティまたはカスタムの HTML ドキュメンテーションは表示されません。

  • name に対応するリファレンス ページがない場合、docname.m または name.mlx という名前のファイル内でヘルプ テキストを検索します。ヘルプ テキストがある場合、doc はそれをヘルプ ブラウザーに表示します。

  • name に対応するリファレンス ページがなく、かつ関連付けられたヘルプ テキストがない場合、docname のドキュメンテーションを検索し、検索結果をヘルプ ブラウザーに表示します。

すべて折りたたむ

関数 abs のリファレンス ページを表示します。

doc abs

複数の製品にバージョンの異なる abs が含まれています。ヘルプ基本設定でそれら製品のドキュメンテーションの表示がサポートされている場合は、ヘルプ ブラウザーに MATLAB® の abs リファレンス ページおよび他のバージョンの abs へのリンクを伴うメッセージが表示されます。このメッセージはページ上部に表示されます。

handle クラスのリファレンス ページを表示します。

doc handle

handle クラス内の findobj メソッドのリファレンス ページを表示します。

doc handle.findobj

containers パッケージ内の Map クラスのリファレンス ページを表示します。

doc containers.Map

カスタム クラスの書式設定済みのヘルプ テキストを表示します。

クラス ファイル sads.m は、クラスの作成方法を示す例のファイルです。例のフォルダーをパスに追加し、sads のドキュメンテーションを要求します。

addpath(...
   fullfile(matlabroot,'help','techdoc','matlab_env',...
   'examples'))
doc sads

sads クラスの steer メソッドのヘルプを表示します。ヘルプ テキストは MATLAB の表記法に従うため、MATLAB によりブラウザー内の表示の書式設定が行われます。

doc sads.steer

入力引数

すべて折りたたむ

関数、クラス、ブロックなどの機能の名前。文字ベクトルとして指定します。あるいは、演算子記号。

一部のクラスとその他のパッケージ化項目では、パッケージ名の指定が必要になります。イベント、プロパティ、一部のメソッドでは、クラス名を指定しなければなりません。次のように、名前の要素をピリオドで区切ります。

doc className.name
doc packageName.name
doc packageName.className.name

一部のクラスのメソッドには doc コマンドを使用してアクセスできません。代わりに、クラス リファレンス ページ上のリンクを使用してアクセスします。

ヒント

  • サードパーティまたはカスタムのドキュメンテーションにアクセスするには、ヘルプ ブラウザーを開いて、ドキュメンテーションのホーム ページへ移動します。次に、ページの下部で、[補助ソフトウェア] をクリックします。

バージョン履歴

R2006a より前に導入