JSDoc 的命令列參數
最基本的 JSDoc 使用方式如下
/path/to/jsdoc yourSourceCodeFile.js anotherSourceCodeFile.js ...
其中 ... 是要為其產生文件檔的其他檔案路徑。
此外，可以提供 Markdown 檔案 (以「.md」結尾) 或名為「README」的檔案路徑，這將會新增至首頁的文件檔中。請參閱 這些說明。
JSDoc 支援許多命令列選項，其中許多選項同時具有長短格式。或者，可以在提供給 JSDoc 的 設定檔中指定 命令列選項。命令列選項如下
| 選項 | 說明 |
|---|---|
-a <value>, --access <value> |
僅顯示具有指定 access 屬性的符號：private、protected、public 或 undefined，或 all 表示所有存取層級。預設會顯示除 private 符號以外的所有符號。 |
-c <value>, --configure <value> |
JSDoc 設定檔 的路徑。預設為安裝 JSDoc 的目錄中的 conf.json 或 conf.json.EXAMPLE。 |
-d <value>, --destination <value> |
產生文件檔的輸出資料夾路徑。對於 JSDoc 內建的 Haruki 範本，請使用 console 將資料傾印至主控台。預設為 ./out。 |
--debug |
記錄有助於除錯 JSDoc 本身問題的資訊。 |
-e <value>, --encoding <value> |
讀取所有原始碼檔案時，假設此編碼。預設為 utf8。 |
-h, --help |
顯示 JSDoc 的命令列選項資訊，然後結束。 |
--match <value> |
僅執行名稱包含 value 的測試。 |
--nocolor |
執行測試時，不要在主控台輸出中使用色彩。在 Windows 中，此選項預設為啟用。 |
-p, --private |
在產生的文件檔中包含標記為 @private 標籤 的符號。預設不會包含私人符號。 |
-P, --package |
包含專案名稱、版本和其他詳細資料的 package.json 檔案。預設為在來源路徑中找到的第一個 package.json 檔案。 |
--pedantic |
將錯誤視為致命錯誤，並將警告視為錯誤。預設為 false。 |
-q <value>, --query <value> |
要剖析並儲存在全域變數 env.opts.query 中的查詢字串。範例：foo=bar&baz=true。 |
-r, --recurse |
在掃描來源檔案和教學課程時遞迴進入子目錄。 |
-R, --readme |
要包含在產生的文件中的 README.md 檔案。預設為在來源路徑中找到的第一個 README.md 檔案。 |
-t <value>, --template <value> |
用於產生輸出的範本路徑。預設為 templates/default，JSDoc 內建的預設範本。 |
-T, --test |
執行 JSDoc 的測試套件，並將結果列印到主控台。 |
-u <value>, --tutorials <value> |
JSDoc 應在其中搜尋教學課程的目錄。如果省略，則不會產生任何教學課程頁面。有關更多資訊，請參閱 教學課程說明。 |
-v, --version |
顯示 JSDoc 的版本號碼，然後結束。 |
--verbose |
在 JSDoc 執行時將詳細資訊記錄到主控台。預設為 false。 |
-X, --explain |
將所有文件以 JSON 格式傾印到主控台，然後結束。 |
範例
使用設定檔 /path/to/my/conf.json，為 ./src 目錄中的檔案產生文件，並將輸出儲存在 ./docs 目錄中
/path/to/jsdoc src -r -c /path/to/my/conf.json -d docs
執行所有名稱包含字詞 tag 的 JSDoc 測試，並記錄每個測試的資訊
/path/to/jsdoc -T --match tag --verbose