@use JSDoc

設定 JSDoc 的預設範本

JSDoc 的預設範本提供多個選項,可讓您自訂產生文件的外觀和內容。

若要使用這些選項,您必須建立設定檔給 JSDoc,並在設定檔中設定適當的選項。

產生漂亮列印的原始碼檔案

預設情況下,JSDoc 的預設範本會產生原始碼檔案的漂亮列印版本。它也會在文件中連結到這些漂亮列印的檔案。

若要停用漂亮列印的檔案,請將選項 templates.default.outputSourceFiles 設定為 false。使用此選項也會從文件中移除連結到原始碼檔案的連結。此選項在 JSDoc 3.3.0 及後續版本中提供。

將靜態檔案複製到輸出目錄

JSDoc 的預設範本會自動將一些靜態檔案(例如 CSS 樣式表)複製到輸出目錄。在 JSDoc 3.3.0 及後續版本中,您可以指示預設範本將其他靜態檔案複製到輸出目錄。例如,您可能想要將一個影像目錄複製到輸出目錄,以便在文件中顯示這些影像。

若要將其他靜態檔案複製到輸出目錄,請使用下列選項

將一個影像目錄複製到輸出目錄

若要將 ./myproject/static 中的所有靜態檔案複製到輸出目錄

{
  "templates": {
    "default": {
      "staticFiles": {
        "include": [
        	"./myproject/static"
        ]
      }
    }
  }
}

如果您的靜態檔案目錄包含檔案 ./myproject/static/img/screen.png,您可以使用 HTML 標籤 <img src="img/screen.png"> 在文件中顯示影像。

預設情況下,JSDoc 的預設範本會在產生文件的頁尾顯示目前日期。在 JSDoc 3.3.0 及後續版本中,您可以透過將選項 templates.default.includeDate 設定為 false 來略過目前日期。

在導覽欄中顯示長名稱

預設情況下,JSDoc 的預設範本會在導覽欄中顯示每個符號名稱的縮短版本。例如,符號 my.namespace.MyClass 會僅顯示為 MyClass。若要顯示完整的長名稱,請將選項 templates.default.useLongnameInNav 設定為 true。此選項在 JSDoc 3.4.0 及更新版本中可用。

覆寫預設範本的版面配置檔案

預設範本使用名為 layout.tmpl 的檔案來指定產生文件中的每個頁面的標頭和頁尾。特別是,此檔案定義了每個頁面載入哪些 CSS 和 JavaScript 檔案。在 JSDoc 3.3.0 及更新版本中,您可以指定要使用的自訂 layout.tmpl 檔案,這讓您可以載入自訂 CSS 和 JavaScript 檔案,除了或取代標準檔案。

若要使用此功能,請將選項 templates.default.layoutFile 設定為自訂版面配置檔案的路徑。相對路徑會相對於目前工作目錄、組態檔案路徑和 JSDoc 目錄(依此順序)解析。