@use JSDoc

语法

使用 JSDoc 标记词典（默认启用）

@private

使用 Closure Compiler 标记词典

@private [{typeExpression}]

概述

@private 标记将符号标记为私有，或不供一般使用。私有成员不会显示在生成的输出中，除非使用 -p/--private 命令行选项运行 JSDoc。在 JSDoc 3.3.0 及更高版本中，您还可以使用 -a/--access 命令行选项 来更改此行为。

@private 标记不会被子成员继承。例如，如果将 @private 标记添加到命名空间，则命名空间的成员仍然可以出现在生成的输出中；因为命名空间是私有的，所以成员的名称路径不会包含命名空间。

@private 标记等效于 @access private。

示例

在以下示例中，Documents 和 Documents.Newspaper 会出现在生成的文档中，但 Documents.Diary 不会出现。

使用 @private 标记
/** @namespace */
var Documents = {
    /**
     * An ordinary newspaper.
     */
    Newspaper: 1,
    /**
     * My diary.
     * @private
     */
    Diary: 2
};