Question

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

示例：

TimerMessage类扩展了Timer。

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部分太冗了。

你的想法是什么？

由于

Answer 1

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

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

使用asdoc command可以将代码转换为漂亮的HTML文档。在这一点上，所有那些冗余的@param事情看起来都不那么冗余，实际上非常简洁。 There are other tags too

评论事件处理程序参数

1 个答案: