Actionscript 3 注释事件处理程序参数

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

例如：

TimerMessage类扩展了计时器

TimerMessage类有一个setMessage方法，该方法将文本消息存储在其公共 var“message”

使用中：

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部分太多余了

你怎么想

---

谢谢

不，不太多余。在我想要记录的任何方法或变量之前，我通常会按Command-Shift-D（在Mac上，在windows上，我认为您可以用控制键替换命令键）

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

---

这可以转化为漂亮的HTML文档，用于您的代码。在这一点上，所有那些冗余的@param东西似乎没有那么冗余，实际上相当整洁

在flashdevelope中，如果你在方法上面键入/**的话，它也会生成ASDoc模板。您应该如何评论处理程序？完全取决于你自己，请阅读以下内容：或者至少看一下Bob Martin叔叔关于姓名的视频：你会意识到，评论除公共API之外的任何内容都是浪费时间，并且会降低代码的可读性。很有趣，谢谢@weltraumpirat