【问题标题】:Usage of @public JsDoc tag along with @export leads to a warning使用@public JsDoc 标记和@export 会导致警告
【发布时间】:2023-04-10 14:50:01
【问题描述】:

我正在尝试使用闭包编译器编译代码并使用 JsDoc 生成仅限公共的文档。

为什么@public 和@export 标签同时使用prohibited?还有一个unit test在查看。

/**
 * @public
 * @export
 */
function hello(name) {
  alert('Hello, ' + name);
}
hello('New user');

当试图编译它时,闭包编译器会抛出一个警告:

JSC_PARSE_ERROR:解析错误。第 4 行字符处的额外可见性标记 3 * @导出

Here is an example 使用在线闭包编译器。

正如here提到的关于@public

表示成员或属性是公共的。标记的属性 任何文件中的所有代码都可以访问@public。这是隐含的 默认且很少使用。这不是用来表示名称应该 保留在混淆构建中,请参阅@export。

那么我怎样才能表明我希望一个特定的符号既是公开的又是导出的呢?

【问题讨论】:

    标签: javascript google-closure-compiler jsdoc3


    【解决方案1】:

    错误告诉您@public 隐含在@export 中。

    导出某些东西意味着它将被外部代码使用,这意味着该项目必须是公共的。

    根据我的经验,您可能只需要知道关于@public 的一件事,那就是问题的一部分:

    [...]这是隐含的默认值,很少使用[...]

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2015-10-04
      • 1970-01-01
      相关资源
      最近更新 更多