ASDOC을 사용하기 위한 태그 처리법

 http://blog.naver.com/logon77/110033298588 

기본적인 내용은 아래 링크를 우선 보세요.

http://blog.jidolstar.com/79

 

기본내용

 

아래와 같은 주석 형태를 해석한다. 
/** 주석내용 */ 

'*'문자만 있으면 그 라인은 공백 라인으로 만든다. 

<p></p> - 문단으로 만든다. 


@tag - /** 부터 이 태그까지의 내용이 package 설명 부분에 나타난다. 

class에 대한 주석은 import 문 아래, class문 위에 작성.

기본 적으로 public class 내에 포함된 주석을 해석하여 문서로 만들어진다. 
@private - 이 태그가 주석에 포함되면 해당 주석이 문서에서 빠진다. 


@copy reference - ex) @copy #stop @copy MovieClip#stop - reference의 주석내용을 복사. main description, @param, @return를 복사한다. 사용법은 @see 태그와 같다. 

@example exampleText - ex) @example The following code sets the volume level for your sound: <listing version="3.0" > var mySound:Sound = new Sound(); mySound.setVolume(VOL_HIGH); </listing> - 샘플을 삽입한다. 

@exampleText string - 외부 @example 소스를 가져온다. 

@inheritDoc - super class나 interface의 주석 내용을 가져온다. 여러단계를 거처 상속이 되었더라도, 각 부모클래스의 주석을 다 가져온다. 

@internal text - text를 감춘다. 

@throws package.class.className description - throw를 던지는 error 메소드를 표현한다. 


property에서 사용하는 태그 

@default null - 기본 값 표현. 

method에서 사용하는 태그 

@param - 메소드의 인자. 
@return - 메소드의 리턴타입. 
@see - 참고 메소드. 

@see 태그 사용법 
@see "Just a label"  문자로 표현 
@see http://www.cnn.com  외부 website 링크 
@see package-detail.html  로컬 HTML file 링크 
@see Array  Top-level class로 링크 
@see AccessibilityProperties  같은 package Class 속성으로 이동 
@see flash.display.TextField  다른 package Class로 이동 
@see Array#length  top level class 속성으로 이동 
@see flash.ui.ContextMenu#customItems  다른 package Class로 속성으로 이동 
@see #updateProperties()  같은 class 내의 메소드 @see 태그로 이동 
@see Array#pop()  top-level class 메소드로 이동 
@see flash.ui.ContextMenu#clone()  다른 package class 메소드로 이동 
@see global#Boolean()  Top Level (global) 메소드로 이동 
@see flash.util.#clearInterval()  flash.util Package 메소드로 이동 


메타데이터 effects, events, styles에서 사용하는 태그 

class문 위에 기입. 

@eventType - 이벤트 타입을 지정. 
[Event(name="buttonDown", type="mx.events.FlexEvent")] 

아래와 같이 해당이벤트의 상수타입 속성에도 지정할수 있다. 
@eventType buttonDown 
public static const BUTTON_DOWN:String = "buttonDown" 



주석에서 사용할수 있는 html 태그 

http://livedocs.adobe.com/flex/201/html/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Book_Parts&file=asdoc_127_8.html#186379

[출처] asdoc 태그 정리|작성자 원범