評論事件處理程序參數

-2

我應該如何評論事件處理程序參數？我的意思是，我應該評論事件處理程序參數？評論事件處理程序參數

示例：

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

你覺得呢？

謝謝

來源

2012-04-14 Marcelo Noronha

坦率地說，我沒有看到這個問題的重點。你應該如何評論處理程序？完全由你決定 – 2012-04-14 05:42:55

做你自己一個忙，並閱讀：http：//www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882或至少看鮑勃馬丁叔叔的視頻演員姓名： http://www.cleancoders.com/codecast/clean-code-episode-2/show你會意識到，除了公共API之外的任何其他評論都是浪費時間，並且使得你的代碼*不可讀。 – weltraumpirat 2012-04-14 09:11:28

有趣的是，謝謝@weltraumpirat – 2012-04-14 13:17:22

不，它不是太多餘。我通常在任何想要記錄的方法或變量之前按Command-Shift-D（在Mac上，在Windows上，我認爲你用Control鍵替換了Command鍵）。

Flash Builder生成一個註釋模板供您填寫，其中包括方法中每個參數的@param。

這可以變成漂亮的HTML文檔，代碼爲asdoc command。在這一點上，所有這些冗餘的參數看起來不那麼多餘，而且實際上非常整齊。 There are other tags too。

來源

2012-04-14 04:14:48

在Flash Develop中，如果您在方法上面鍵入/ **，它也會生成ASDoc模板。 – user1103976 2012-04-14 05:26:43

評論事件處理程序參數

回答

相關問題