사용자정의 클래스를 만들 때
메서드와 이벤트리스너(Event를 Dispatch하는 클래스일 경우)와 관련된 코드힌트를 띄우는 방법입니다.
FlashDevelop(플래시디벨롭)으로만 해 본 거라서
다른 액션스크립트 개발툴에서도 되는지는 모릅니다.
1. Method details
/**
* This is function.
* @param a parameter1
* @param b parameter2
* @return something
*/
public function func1(a:int, b:String):int
{
return 0;
}
메서드 func1()을 사용할 때 코드힌트가 뜬다.
2. Event 메타태그
[Event(name = "complete", type = "flash.events.Event")]
public class ClassA extends EventDispatcher {
아래와 같이 addEventListenr( 를 입력하면 등록해놓은 이벤트가 뜬다.
이벤트가 여러개일 경우엔 메타태그를 여러 번 써도 된다.
1번과 같은 경우는 'documentation'이라고 해서 ASDoc문서를 구성할 수 있는 것들이다.
클래스 선언부 위에
/**
*
*
*/
과 같은 꼴로 'documentation box'를 만들어서 @author, @version, @eventType등의 정보를 쓰고
메서드 선언부 위에도 @param, @return 등의 documentation tag를 달 수 있다.
자세한 내용은 documentation tag나 AsDoc 등의 검색어로 검색해보면 잘 나오니 pass..
p.s. /** ... */ 꼴 대신 슬래시를 3개 쓴 ///를 써도 가능하다.
