@access Back

This tag is mainly used for specifying the accessibility level of members: package, private, protected, and public.

• @access package is the same as @package.
• @access private is the same as @private.
• @access protected is the same as @protected.
• @access public is the same as @public.

Note: Private members are not shown in the generated output unless JSDoc is run with the -p/--private command-line option.

a doclet's access level is different from its scope. It means that documenting with such a tag won't change its real running scope.

class Base {
    constructor() {
        /**
         * @type {number}
         * @private
         */
        this._private = 0;

        /**
         * @type {number}
         * @protected
         */
        this._protected = 1;

        /**
         * @type {number}
         * @public
         */
        this.public = 2;
    }
}

class Inherit extends Base {
    constructor() {
        super();
    }

    getPrivate() { console.log(this._private); /** Private member is not accessible */ }
}

Comments Copyright © aleen42 all right reserved, powered by aleen42

Empty Comments

Sign in GitHub

As the plugin is integrated with a code management system like GitLab or GitHub, you may have to auth with your account before leaving comments around this article.

Notice: This plugin has used Cookie to store your token with an expiration.

authorize