18Май/13Off
Документирование событий в ActionScript3 @eventType
Документирование событий в ActionScript3 @eventTypeПри написании кода очень важно оставлять комментарии и документировать методы/классы/события и т.д. Правильно описанный и задокументированный класс проще поддерживать, среда сможет дать более полную информацию о нем (в данном случае например предложить правильное автозаполнение для addEventListener
/removeEventListener
), да и выглядит он просто красивее.
Итак рассмотрим, как следует поступать, когда ваш as3 класс диспатчит события. Пусть у нас есть класс MyDispatcher
, который должен испускать события при начале и окончании работы. Опишем его и задокументируем в соответствии с правилами ASDoc.