doc

システムの Web ブラウザーでのドキュメンテーション

ページ内をすべて折りたたむ

構文

doc
doc name

説明

doc は、システムの Web ブラウザーの新しいタブにドキュメンテーションを開きます。システムの Web ブラウザーが開いているが表示されていない場合、doc により前面に移動されます。

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

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

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

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

例

例

すべて折りたたむ

ライブ スクリプトを開く

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

doc abs
ライブ スクリプトを開く

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

doc handle

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

doc handle.findobj

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

doc containers.Map
ライブ スクリプトを開く

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

ファイル sads.m はカスタム クラスのサンプル ファイルです。クラスの書式設定済みのヘルプ テキストを表示します。ヘルプ テキストは MATLAB の規則に従うため、MATLAB で別のウィンドウにヘルプ テキストが表示されます。

doc sads

sads クラスの steer メソッドのヘルプを表示します。MATLAB で別のウィンドウにヘルプ テキストが表示されます。

doc sads.steer

入力引数

すべて折りたたむ

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

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

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

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

ヒント

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

バージョン履歴

R2006a より前に導入

すべて展開する

参考

| | |

トピック