@use JSDoc

包含 README 檔案

有兩種方法可以將 README 檔案納入您的文件

  1. 在 JavaScript 檔案的來源路徑中，包含名為 README.md 的 Markdown 檔案路徑。JSDoc 會使用在來源路徑中找到的第一個 README.md 檔案。
  2. 使用 -R/--readme 命令列選項執行 JSDoc，指定 README 檔案的路徑。此選項在 JSDoc 3.3.0 及後續版本中可用。README 檔案可以有任何名稱和副檔名，但必須採用 Markdown 格式。

-R/--readme 命令列選項優先於您的來源路徑。如果您使用 -R/--readme 命令列選項，JSDoc 會忽略來源路徑中的任何 README.md 檔案。

如果您使用 JSDoc 的預設範本，README 檔案的內容會以 HTML 形式呈現於產生的文件 index.html 檔案中。

範例

在來源路徑中包含 README 檔案
jsdoc path/to/js path/to/readme/README.md
使用 -R/--readme 選項
jsdoc --readme path/to/readme/README path/to/js