Как правильно указать, что функция запускает событие в элементе Polymer?

1

Учитывая следующий, невероятно упрощенный, настраиваемый элемент Polymer, как я должен документировать событие "добавленных номеров", которое запускается функцией "добавить", чтобы оно отображалось на страницах документации, сгенерированных страницей iron-component-page (изображение ниже)?

<dom-module id="my-element">
  <template>
    <style>
      :host { display: block; }
    </style>
  </template>
  <script>
    Polymer({
      is: 'my-element',
      properties: {
        // properties go here
      },
      /**
      * Just adds two numbers together and fires an event.
      * @param {Number} a The first number
      * @param {Number} b The second number
      * @fires my-element#added-numbers I WANT TO DOCUMENT THE EVENT HERE
      */
      add: function (a, b) {
        var c = a + b;
        this.fire('added-numbers', { value: c });
      }
    });
  </script>
</dom-module>

Изображение 174551

Сама документация "Полимер " показывает, как документировать событие, как если бы оно было функцией (с суммой и параметрами), но не показывает пример того, как документировать функцию, которая должна запускать событие (или более одного),

Я просмотрел стандарт JSDoc для документации JavaScript и имеет тег @fires который, как представляется, является тем, чем я являюсь (и я попытался использовать его выше), но он игнорируется при создании страниц документа.

Я использую версию Polymer 1.9, если это имеет значение.

Теги:
polymer
documentation
polymer-1.0

1 ответ

1
Лучший ответ

Используйте аннотацию @event. просто добавьте новый блок комментариев перед вашей функцией или где-нибудь еще внутри вашего элемента

 /**
  * Just adds two numbers together and fires an event.
  * @param {Number} a The first number
  * @param {Number} b The second number
  */
  add: function (a, b) {
    var c = a + b;
    this.fire('added-numbers', { value: c });
  }

 /**
 * Fired when .....
 *
 * @event event-name
 * @param {{eventParam:boolean}} detail -
 *     eventParam: true if .....
 */
  • 0
    Спасибо Хиян! Я просто хочу кое-что прояснить, прежде чем принять ваш ответ: с первым предложением ничего не добавляется на страницу документации, но это со вторым. Это то, что вы ожидаете?
  • 1
    @Ben да, это то, что я ожидал, первый не будет работать, так как @event должен иметь свой собственный блок комментариев, исправлено это сейчас
Показать ещё 1 комментарий

Ещё вопросы

Сообщество Overcoder
Наверх
Меню