@use JSDoc

概要

@public タグは、シンボルをパブリックであるかのようにドキュメント化することを示します。

デフォルトでは、JSDoc はすべてのシンボルをパブリックとして扱います。このため、このタグを使用しても、通常は生成されたドキュメントには影響しません。ただし、シンボルをパブリックにする意図があることを他の人に明確にするため、@public タグを明示的に使用する方が好ましい場合があります。

JSDoc 3 では、@public タグはシンボルのスコープに影響しません。シンボルのスコープを変更するには、@instance、@static、@global タグを使用します。

例

@public タグを使用する
/**
 * The Thingy class is available to all.
 * @public
 * @class
 */
function Thingy() {
    /**
     * The Thingy~foo member. Note that 'foo' is still an inner member
     * of 'Thingy', in spite of the @public tag.
     * @public
     */
    var foo = 0;
}