MATLAB Function Reference

help

在命令視窗中顯示 MATLAB 函式的幫助文件

Syntax

help
help /
help function
help toolbox/
help toolbox/function
help syntax

Description

help 在命令視窗中列出所有主要的求助主題. 每個主要的求助主題都符合 MATLAB 搜尋路徑的目錄名稱.

help / 列出所有的運算子及特殊符號, 以及它們的描述.

help function  列出 M檔案的幫助文件,(M file help)  這是在命令視窗中函式簡單的描述及語法. 若函式有被重載, 將顯示在搜尋路徑上第一個被發現函式的 M檔案的幫助文件, 並且列出重載的函式( overloaded functions).

help toolbox/ 列 出toolbox詳細目錄的內容檔案. 並不需要給此目錄的完整路徑名稱; 只需給最後一個部分, 或是最後幾個部分就有效.

help toolbox/function 顯示屬於toolbox目錄下 function的 M檔案的幫助文件.

help syntax 顯示被MATLAB命令和函式所使用文法的 M檔案求助描述.

Note     M檔案幫助文件顯示在命令視窗中時, 使用大寫英文以便於和文件中其他部分分開. 當鍵入函式名稱, 使用小寫英數字. 一些 Java 的介面的函數則大小寫混合鍵入; 若要明確指明 M檔案, 則在鍵入時若摻雜大小寫使用.

Remarks

為你自己的 M檔案撰寫說明文件 ( Creating Online Help for Your Own M-Files )

MATLAB 的求助系統, 就像 MATLAB 本身, 是可高度擴張的. 只要符合 MATLAB 的規格, 你也可以為自己的 M檔案和工具箱寫求助描述：

help 函式會顯示你所搜尋到的所有 M檔案的第一行註解行, 而在每個資料夾中有個 content.m 的檔案是為此資料夾的目錄資料檔.

在鍵入help topic時, 若 topic是目錄名稱, 顯示在那個目錄中 Contents.m檔案的註解行. 若目錄檔案不存在, 則 help顯示在目錄下所有檔案的第一行文字.

鍵入 help topic時, 若topic是一個函式名稱, 則列出topic.m的第一個連續的註釋行當作這個函式的說明.

舉例來說, angle.m的內容為：

function p = angle(h)
% ANGLE Polar angle.
% ANGLE(H) returns the phase angles, in radians, of a matrix
% with complex elements. Use ABS for the magnitudes.
p = atan2(imag(h),real(h));

當你執行 help angle時, 第 2, 3, 和 4行會顯示出來.這幾行是第一個註解區塊. 但在任可執行的描述後或是空白行後, 幫助文件系統忽略在 M檔案出現在後面的註解欄,.

在任何 M檔案的第一個註解行應該是特殊且重要的.它應該包含函數名稱及此函數的簡短描述.lookfor函數搜尋並顯示這一行,而 help顯示這幾行若是在目錄中不包含 Contents.m 檔案.

為你的 M檔案資料夾撰寫目錄 ( Creating Contents Files for Your Own M-File Directories )

在所有 MATLAB 的 M檔案目錄中都有提供一個 Contents.m 檔案, 若你也建立了一個自己的 M檔案目錄的話, 記得也要順便建立一個 Contents.m 檔案, 你可以參照現有的 contents.m 檔案來建立它.

Examples

鍵入

help datafun

秀出 datafun 目錄的求助.

鍵入

help fft

顯示出 fft 函數的說明文件.

在閱讀時為了怕內容太多而捲動超過螢幕,輸入 more on , 然後再輸入 help函數.

See Also

doc, helpbrowser, helpwin, lookfor, more, partialpath, path, what, which

hdfread

helpbrowser