Javascript 说明函数在聚合元素中触发事件的正确方式是什么?

Javascript 说明函数在聚合元素中触发事件的正确方式是什么?,javascript,polymer,documentation,polymer-1.0,Javascript,Polymer,Documentation,Polymer 1.0,考虑到以下极其简化的自定义聚合元素,我应该如何记录由“添加”函数触发的“添加的数字”事件,以便它出现在由铁组件页面生成的文档页面中(下图) :host{display:block;} 聚合物({ 是‘我的元素’, 特性:{ //财产在这里 }, /** *只需将两个数字相加,即可触发一个事件。 *@param{Number}a第一个数字 *@param{Number}b第二个数字 *@fires my element#添加了数字我想在这里记录事件 */ 加:功能(a、b){ var c=a+b

考虑到以下极其简化的自定义聚合元素,我应该如何记录由“添加”函数触发的“添加的数字”事件,以便它出现在由
铁组件页面生成的文档页面中(下图)


:host{display:block;}
聚合物({
是‘我的元素’,
特性:{
//财产在这里
},
/**
*只需将两个数字相加,即可触发一个事件。
*@param{Number}a第一个数字
*@param{Number}b第二个数字
*@fires my element#添加了数字我想在这里记录事件
*/
加:功能(a、b){
var c=a+b;
this.fire('added-numbers',{value:c});
}
});

Polymer文档展示了如何将事件当作函数(带有摘要和参数)来记录,但没有展示如何记录预期触发事件(或多个)的函数的示例

我已经看过了JavaScript文档的JSDoc标准,它有一个标记,似乎就是我想要的(我在上面尝试过使用它),但是在生成文档页面时它被忽略了


我使用的是Polymer 1.9版,如果有什么不同的话。

使用
@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 .....
 */

谢谢Hyan!不过,在接受您的回答之前,我只想澄清一点:对于第一个建议,文档页面中没有添加任何内容,但是对于第二个建议。这就是你所期望的吗?@Ben是的,这就是我所期望的,第一个不会工作,因为
@event
必须有自己的注释块,现在已经修复了这是一个遗憾,但至少我现在知道了。事实上,Polymer文档非常准确,只是需要更清楚,它应该是一个独立的评论块!谢谢@Hyyan
 /**
  * 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 .....
 */