JSDoc中文文档(@use JSDoc)

JSDoc @private 标签

目录

语法

使用JSDoc标签字典（默认启用）：

@private

使用Closure Compiler标签字典：

@private [{typeExpression}]

概述

@private标签标记标识符为私有，或者不做一般用途使用。私有成员不会在生成文档中输出任何内容，除非JSDoc使用 -p/--private 命令行选项运行。在JSDoc3.3.0或更高版本中，您还可以使用 -a/--access 命令行选项来改变这种行为。

@private标签不被子成员继承。 例如，如果@private标记添加到命名空间，命名空间的成员仍然会输出到生成的文档中;因为命名空间是私有的，成员的 namepath 不包含在命名空间中。

@private标签和@access private是等价的。

示例

在下面的例子中，Documents和Documents.Newspaper会被输出到生成的文档中，但是Documents.Diary不会。

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