使用ASDoc標簽生成ActionScript3.0 API文檔

Clare 12年前發布 | 1K 次閱讀 Linus Torvalds

    常用FLASH ASDoc 文檔注釋標簽

@param paramName description
     描述方法或構造函數的單個參數。
     paramName:參數名。
     description:參數說明。

@return description
     描述方法的返回值。
     description:返回值的說明。

@throws package.class.className description
     聲明一個可能被拋出的錯誤。
     package.class.className:錯誤的類型名稱。
     description:對引發錯誤的說明。

@default value
     指定屬性、式樣、或效果的默認值。
     value:默認值。

@eventType package.class.CONSTANT
     描述事件的類型,即事件對象的 type 屬性值。
     package.class.CONSTANT:一般為事件類的公共常量,定義事件對象的 type 屬性值;也可以是表示事件類型的字符串。
 
@see reference [displayText]
     添加一個“另請參見”項,并創建到某一成員的鏈接。
     reference:成員的 API 名稱。具體形式如下:
     ?@see http://www.examples.com
     ?@see MyClass
     ?@see package.MyClass
     ?@see MyClass#name
     ?@see #method()
     ?@see MyClass#method()

    displayText:可選,該鏈接的顯示文字。
 
@example exampleText
     提供類型或某一成員的使用示例。
     exampleText:示例的文本內容,通常包含 <listing version="3.0"></listing> 標記,該標記的內容被識別為程序代碼。
 
@deprecated
     標記該 API 已過時。

      除了使用adobe的ASDoc工具以外,還可以使用DocsBuilder分析包含這些文檔標簽的AS2/AS3類文件源碼,生成API文檔。
 
     DocsBuilder還可以通過自定義模板文件,生成任何想要的文檔內容。

    下載地址:http://www.shinater.com/DocsBuilder/DocsBuilderGUI.zip

     DocsBuilder主頁:http://www.shinater.com/DocsBuilder.xhtml

 本文由用戶 Clare 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!