跳至內容

jsdoc/check-access 限制

功能

檢查 @access 標籤是否使用以下其中一個值

  • "package"、"private"、"protected"、"public"

也會回報

  • 在同一個文件區塊中混合使用 @access@public@private@protected@package
  • 在同一個文件區塊中使用多個 @access (或 @public 等) 的情況。

為什麼這是不好的?

擁有一個一致的方式來指定存取級別非常重要。

範例

此規則的不正確程式碼範例

javascript
/** @access private @public */

/** @access invalidlevel */

此規則的正確程式碼範例

javascript
/** @access private */

/** @private */

參考資料

以 MIT 授權發布。