Слушатель событий документирования JSDOC (addEventListener) - PullRequest
0 голосов
/ 25 октября 2019

Относительно JSDOC:

После копания в API у меня возникают проблемы с пониманием тегов @ event / @ fires / @ listens:

, в частности, тег @listens https://devdocs.io/jsdoc/tags-listens enter image description here

Теги обсуждаются только в очень конкретном контексте: пользователь создает пользовательские события.

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

window.addEventListener('load', currentWeatherConditions);

Даже при добавленном теге @listener, как и в документации, ничего о прослушивателе событий не отображается в сгенерированном HTML.

Как получить @listenerбыть задокументированным и отображаться в сгенерированном HTML JSDOC? Ничего о событиях не отображается в документации модуля контроллера приложений индекса, где слушатель событий: enter image description here

Я начал использовать JSDOC, который генерирует HTML-страницы, которые люди могут просматривать в браузере, чтобы быстропонять приложение. Так что было бы неплохо, если бы мои слушатели показывали в сгенерированном HTML.

...