actionscript-3 - 评论事件处理程序参数

Question

我应该如何评论事件处理程序参数？我的意思是，我应该评论事件处理程序参数吗？

例子：

TimerMessage 类扩展了 Timer。

TimerMessage 类有一个 setMessage 方法，该方法将文本消息存储在其公共变量“消息”中。

在使用中：

var timer_message:TimerMessage = new TimerMessage(1000, 1)
timer_message.setMessage('hello')
timer_message.addEventListener(TimerEvent.TIMER_COMPLETE, displayMessage)

private function displayMessage(e:TimerEvent):void{
txt.text = e.target.message
e.target.stop()
e.target.removeEventListener(TimerEvent.TIMER_COMPLETE, displayMessage)
}

我应该如何评论 displayMessage 处理程序？

/* Displays message on main stage
 * @param e - timer event
 * */

像那样？

我认为@param 部分太多余了。

你认为呢？

谢谢

Answer 1

不，这不是太多余。我通常在我想要记录的任何方法或变量之前按 Command-Shift-D（在 Mac 上，在 Windows 上，我认为您将 Command 键替换为 Control 键）。

Flash Builder 会生成一个注释模板供您填写，其中包括方法中每个参数的@param。

可以使用asdoc 命令将其变成漂亮的 HTML 文档，供您的代码使用。在这一点上，所有那些多余的 @param 东西似乎不那么多余了，而且实际上非常整洁。还有其他标签。