使用 JSDoc - JSDoc 繁體中文

概觀

使用 @inner 標籤會將符號標記為其父符號的內部成員。這表示它可以由「Parent~Child」參照。

使用 @inner 會覆寫文件說明的預設範圍（除非它在全域範圍內，這種情況下它仍會保持全域）。

使用 @inner 將虛擬文件說明設為內部成員

/** @namespace MyNamespace */
/**
 * myFunction is now MyNamespace~myFunction.
 * @function myFunction
 * @memberof MyNamespace
 * @inner
 */

請注意，在上述範例中，我們可以使用「@function MyNamespace~myFunction」取代 @memberof 和 @inner 標籤。

使用 @inner

/** @namespace */
var MyNamespace = {
    /**
     * foo is now MyNamespace~foo rather than MyNamespace.foo.
     * @inner
     */
    foo: 1
};

在上述範例中，我們使用 @inner 強制將名稱空間的成員記錄為內部成員（預設情況下，它會是靜態成員）。這表示 foo 現在具有長名稱 MyNamespace~foo，而不是 MyNamespace.foo。