Использование тега @public JsDoc вместе с @export приводит к предупреждению - PullRequest
1 голос
/ 25 сентября 2019

Я пытаюсь скомпилировать код, используя закрывающий компилятор, и сгенерировать только публичную документацию, используя JsDoc.

Почему использование тегов @public и @export одновременно запрещено ?Существует также модульный тест , проверяющий его.

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

При попытке скомпилировать это, компилятор закрытия выдает предупреждение:

JSC_PARSE_ERROR: Ошибка разбора.дополнительный тег видимости в строке 4 символа 3 * @ export

Вот пример с использованием онлайн-компилятора закрытия.

Как уже упоминалось здесь about @ public :

Указывает, что элемент или свойство являются публичными.Свойство, помеченное @public, доступно для любого кода в любом файле.Это неявное значение по умолчанию и используется редко.Это не используется, чтобы указать, что имя должно быть сохранено в запутывающих сборках, см. @Export.

Итак, как я могу указать, что я хочу, чтобы определенный символ был и публичным, и экспортированным?

1 Ответ

0 голосов
/ 25 сентября 2019

Ошибка говорит вам, что @public подразумевается @export.

Экспорт чего-либо подразумевает, что он будет использоваться внешним кодом, и это означает, что элемент должен быть общедоступным.

По моему опыту, вам, вероятно, нужно знать только одну вещь о @public, и это из части вопроса:

[...] Это неявное значение по умолчанию иредко используется [...]

...