@ public JsDoc标记与@export的使用会导致警告

问题描述 投票:1回答:1

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

为什么同时使用[public]和@export标签prohibited?还有一个unit test正在对其进行检查。

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

[尝试编译时,闭包编译器会发出警告:

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

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

如关于[[@public的here所述:

表示成员或财产是公开的。标有属性@public可访问任何文件中的所有代码。这是隐式的默认且很少使用。这并不表示该名称应保留在混淆的版本中,请参阅@export。

因此,如何指示我希望某个特定符号同时公开和导出?

javascript google-closure-compiler jsdoc3
1个回答
0
投票
错误告诉您@public隐含@export

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

根据我的经验,您可能只需要了解有关@public的一件事,而这是来自问题的一部分:

[...]这是隐式默认值,很少使用[...]
© www.soinside.com 2019 - 2024. All rights reserved.