Skip to main content

[AS3] ASDoc 快速上手

資料出處 ：Using ASDoc

常聽到有人問如何輸出 ActionScript API 文件，在這邊簡單的與大家分享建立 ASDoc 的其中兩個方法：

1. 使用 Flex SDK
請先下載 Flex SDK 解壓後會在 bin 內找到 ASDoc
運行環境：Mac OSX 10.5
打開 應用程式 / 工具程式 / 終端機
直接將 ASDoc( Unix ) "拉"到 終端機視窗內...沒錯！OSX 就是這樣有人性啊！不得不讚嘆...回到正題，接著鍵入：(asdoc後面)
如果你的 as sources 是在 /Users/yourName/myProject/src 下
想要整包輸出就是指定 ： -doc-sources

Last login: Tue Dec 9 14:58:35 on xxxx
Your-macbook-pro:~ yourName$ /Users/yourName/flex_sdk/bin/asdoc -doc-sources /Users/yourName/myProject/src -main-title "XX API Documentation" -window-title "XX API Documentation" -output /Users/yourName/myProject/doc


運行環境：Windows XP pro
如果嫌麻煩就設好 FlexSDK\bin 的環境變數，不懂如何設定的話請愛用 google 搜尋。
打開 開始列 / 程式集 / 附屬應用程式 / 命令提示字元
如果你已經設好環境變數的話可以直接鍵入：如果沒有就乖乖的用 cd 到 FlexSDK\bin下
asdoc -doc-sources D:\yourFlexProjectPath\src -main-title "XX API Documentation" -window-title "XX API Documentation" -output D:\yourFlexProjectPath\doc

按下 Enter 如果沒有意外的就幾秒後就可以在 doc/內找到輸出好的 html 囉！
PS. 我發現 ASDoc 檢查的比 Flex Compiler 還嚴謹，所以要平安無事的輸出好就得小心 Flex 檢查出來的黃色三角警告。

2. Flex Builder3
如果使用 Flex Builder3就沒有運行環境的差別嚕！
打開下拉是功能表 Run / External tools 或者是直接點選快速鍵列上相同的功能：


打開後點選 Program 按滑鼠右鍵 New 一個新的 tool


輸出的格式會以運行的系統語系為主，如果你需要輸出 UTF-8 的話請點選 Command 修改


資料出處有完整的 ASDoc 格式語法說明，想要輸出漂亮的 API Document 就乖乖的讀一遍吧！=P
Labels:

Comments

  1. milkmidiDecember 10, 2008 at 10:54 AM

    Erin姐姐
    真是太實用的文章啦
    剛好正要研究就看到這一篇

    ReplyDelete
  2. UnknownDecember 25, 2008 at 7:59 PM

    This comment has been removed by the author.

    ReplyDelete
  3. UnknownApril 25, 2009 at 12:20 PM

    Erin大，你嵌入的附圖失效了喔～

    ReplyDelete
  4. Erin LinApril 27, 2009 at 3:12 PM

    修好囉~~

    ReplyDelete
  5. wenAugust 13, 2010 at 11:52 PM

    有沒有 flash builder 生成swc 的資料 ？妹妹

    ReplyDelete
  6. Erin LinAugust 17, 2010 at 4:57 PM

    我回答過了...請 google 找吧...有 plug-in 可以用

    ReplyDelete

Post a Comment

Popular posts from this blog

PureMVC 我也會 [0]

最近感覺 PureMVC 又熱了起來，也剛好好久沒有更新文章了， 就順便將去年底做的企業內訓 PureMVC 課程部分整理寫出來， 要講 PureMVC 當然要先從啥是 MVC 講起： Model-View-Control 出處： 維基百科 MVC ，大概節錄一段： （控制器Controller）- 負責轉發請求，對請求進行處理。 （檢視View） - 介面設計人員進行圖形介面設計。 （模型Model） - 程式設計師編寫程式應有的功能（實作算法等等）、數據庫專家進行資料管理和數據庫設計(可以實作具體的功能)。 其實到 Flash 的世界來講，Model and Control 都是由 .as 處理，而 View 便是 .fla+.as ，為了要鬆綁之間的關係，Event 機制就相當重要。其實每個人對 MVC 的最佳解釋都不同，真的要多練習才會有所領悟。 簡單來說： Model = 餐廳廚房 data: 西餐類 action：依照點菜單做餐點 action: 做完餐點就是將餐點放在出菜口按下通知鈴等服務生來 Control ＝ 服務生 action: 聽到大門歡迎鈴就要說「歡迎光臨」 action: 看到客人揮揮手要去收點菜單 action: 聽到廚房通知鈴看是哪桌的餐點去送菜 View = 餐廳外場 view: 田園式的西餐廳裝潢 action: 客人進門會有歡迎鈴 action: 客人揮揮手叫服務生過來服務，是哪個服務生都無所謂，重點只要會收點菜就行了。 action: 客人收到餐點準備開動 當餐廳要改成外炒店，這時候只需要將大廚換成會中餐廚師，其出的菜就是中式快炒。 當餐廳外場由田園式外觀重新裝潢成華麗感夜店風，其進門的客層也會有所不同。 重點就是當你換掉一個地方時，對其它的部份不會造成太大的影響或者根本無所謂，這就是 MVC 所講求的境界... 一般來說，小專案有沒有必要使用 MVC 就是由各位自己判斷了，當你習慣將程式切分開來，發現 debug 不是一件痛苦的事情時，這時候有沒有強制使用 MVC 倒不是重點，因為你已經養成良好的撰寫習慣。但是開始接觸大型專案配合 team work 時，在沒有一個共用的核心框架前提下，這個專案開發到最後一定會是一個多手多腳的怪物，共用核心框架的價值就在這邊展現，這
4 comments
Read more

[Swift3] weak 與 unowned 關鍵字

雖然在 Swift 中看起來"很像"是不需要煩惱內存管理的問題，不過實際上它還是遵循著自動引用計數 (ARC) 的規則，當一個物件沒有被其他對象引用時會自動被銷毀，如果三魂七魄沒有完全回位的話，就會有個靈體留在現世的空間裡，最經典的範例如下： 閉包(Closure)引用 classClassA { typealias Complete = ()->() var name : String var onComplete : Complete? init(_ name: String){ self.name = name print("Hello I am \(self.name)") onComplete = { print("\(self.name): onComplete!") // --> 閉包引用 self, 計數 + 1 } } deinit { print("deinit: \(self.name)") } } var a : ClassA? = ClassA("A") // --> 引用計數 + 1 a = nil // 2-1 = 1 還剩下 1 所以沒辦法銷毀 ---output------- Hello I am A 由於這邊的 onComplete 宣告為 Optional, 正確的做法要連同 onComplete 一起刪除才可以被回收，若不是 Optional 則會進入無法回收狀態： var b : ClassA? = ClassA("B") b?.onComplete = nil // --> 還好是 Optional 可以設成 nil 計數 - 1 b = nil // 計數 = 0 所以被回收 ---output------- Hello I am B deinit: B 但是做人不需要煩惱太多，這時候就出動 unowned 關鍵字讓物件可以順利被回收： onComplete = { [unowned self] in print
4 comments
Read more