索引

開始使用

開始使用 JSDoc: 快速開始使用 JSDoc 記錄 JavaScript。
在 JSDoc 中使用名稱路徑: 在 JSDoc 中使用名稱路徑的指南。
JSDoc 的命令列引數: 關於 JSDoc 的命令列引數。
使用設定檔設定 JSDoc: 如何使用設定檔設定 JSDoc。
設定 JSDoc 的預設範本: 如何設定 JSDoc 預設範本的輸出。
區塊和內嵌標籤: 區塊和內嵌 JSDoc 標籤的概觀。
關於 JSDoc 外掛程式: 如何建立和使用 JSDoc 外掛程式。
使用 Markdown 外掛程式: 在 JSDoc 中啟用 Markdown 支援。
教學: 將教學新增到您的 API 文件。
包含套件檔案: 如何在您的文件顯示套件詳細資料。
包含 README 檔案: 如何在您的文件包含 README 檔案。
授權: JSDoc 的授權資訊。

JSDoc 範例

ES 2015 類別: 如何將 JSDoc 註解新增到 ECMAScript 2015 類別。
ES 2015 模組: 如何將 JSDoc 註解新增到 ECMAScript 2015 模組。
CommonJS 模組: 如何將 JSDoc 註解新增到 CommonJS 和 Node.js 模組。
AMD 模組: 如何將 JSDoc 註解新增到 AMD 和 RequireJS 模組。

區塊標籤

@abstract（同義詞：@virtual）: 這個成員必須由繼承者實作（或覆寫）。
@access: 指定此成員的存取層級（私有、套件私有、公開或受保護）。
@alias: 將成員視為具有不同名稱。
@async: 指出函式是非同步的。
@augments（同義詞：@extends）: 指出符號繼承自父符號並新增到父符號。
@author: 識別項目的作者。
@borrows: 這個物件使用另一個物件中的某個東西。
@class（同義詞：@constructor）: 此函式旨在使用「new」關鍵字呼叫。
@classdesc: 使用以下文字描述整個類別。
@constant（同義詞：@const）: 將物件記錄為常數。
@constructs: 此函式成員將成為前一個類別的建構函式。
@copyright: 記錄一些版權資訊。
@default（同義詞：@defaultvalue）: 記錄預設值。
@deprecated: 文件，這不再是首選方式。
@description（同義詞：@desc）: 描述符號。
@enum: 記錄相關屬性的集合。
@event: 記錄事件。
@example: 提供如何使用記錄項目的範例。
@exports: 識別 JavaScript 模組所輸出的成員。
@external（同義詞：@host）: 識別外部類別、命名空間或模組。
@file（同義詞：@fileoverview、@overview）: 描述檔案。
@fires（同義詞：@emits）: 描述此方法可能觸發的事件。
@function（同義詞：@func、@method）: 描述函式或方法。
@generator: 指出函式是產生器函式。
@global: 記錄全域物件。
@hideconstructor: 指出不應顯示建構函式。
@ignore: 從記錄中省略符號。
@implements: 此符號實作介面。
@inheritdoc: 指出符號應繼承其父項目的記錄。
@inner: 記錄內部物件。
@instance: 記錄執行個體成員。
@interface: 此符號是介面，其他介面可實作。
@kind: 這是什麼類型的符號？
@lends: 記錄物件文字中的屬性，彷彿它們屬於具有特定名稱的符號。
@license: 識別適用於此程式碼的授權。
@listens: 列出符號所偵聽的事件。
@member（同義詞：@var）: 記錄成員。
@memberof: 此符號屬於父項目的符號。
@mixes: 此物件會混入來自其他物件的所有成員。
@mixin: 記錄 mixin 物件。
@module: 記錄 JavaScript 模組。
@name: 記錄物件的名稱。
@namespace: 記錄命名空間物件。
@override: 指出符號會覆寫其父項目。
@package: 此符號應為封裝私有。
@param（同義詞：@arg、@argument）: 記錄函式的參數。
@private: 此符號應為私有。
@property（同義詞：@prop）: 記錄物件的屬性。
@protected: 此符號表示受保護。
@public: 此符號表示公開。
@readonly: 此符號表示唯讀。
@requires: 此檔案需要 JavaScript 模組。
@returns (同義字： @return): 記錄函式的傳回值。
@see: 參閱其他文件以取得更多資訊。
@since: 此功能何時新增？
@static: 記錄靜態成員。
@summary: 完整說明的簡短版本。
@this: 「this」關鍵字在此處指的是什麼？
@throws (同義字： @exception): 說明可能會引發哪些錯誤。
@todo: 記錄待完成的任務。
@tutorial: 插入連結至包含的教學檔案。
@type: 記錄物件的類型。
@typedef: 記錄自訂類型。
@variation: 區分具有相同名稱的不同物件。
@version: 記錄項目版本號碼。
@yields (同義字： @yield): 記錄產生器函式產生的值。

內嵌標籤

@link (同義字： @linkcode, @linkplain): 連結至文件中的其他項目。
@tutorial: 連結至教學。

貢獻

GitHub 上的 JSDoc 專案: 貢獻 JSDoc。
GitHub 上的 JSDoc 文件專案: 貢獻 JSDoc 文件。

在 GitHub 上 Fork 我