将@public JsDoc标记与@export一起使用会导致警告

时间:2019-09-25 10:13:50

标签: javascript google-closure-compiler jsdoc3

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

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

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

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

  

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

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

如关于{strong> @public 的here所述:

  

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

那么我该如何指示我希望某个特定符号同时公开和导出?

1 个答案:

答案 0 :(得分:1)

错误告诉您@public暗示@export

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

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

  

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