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

[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

[作品]Flex 3.4 + PureMVC 的企業級 RIA 應用

認識 Erin 的人都知道， Erin 最懶得寫作品集相關的文章，但是這個案子比較有趣，所以特別提出來聊一下囉！ 廚櫃業某公司內部軟體，目前系統尚在 Beta 階段，所以下面圖片皆有模糊化處理。 [可擴充功能面板首頁，後台皆包含在管理系統內（有 iPhone 的 fu）] 這個案子是幫一家傳統公司做的專用軟體線上化，想要開發企業級 RIA 想當然爾就是使用 Flex 來處理囉！ 整個案子前端是以 Flex SDK 3.4 + Flex Builder3, PureMVC MultiCore for AS3 , Utility - AS3 StateMachine 以及先前 Erin 所發表的 WidgetsConsole 來處理整個系統的轉換。 整個系統包含前後台共七大系統，分別是：估價，客戶，店面管理，貨品上架，會員管理，分店系統以及權限系統。超級管理員可以利用權限系統分別開出不同職級的權限，然後使用者透過同一入口，依照權限區分，畫面會顯示不同的功能。整個系統最複雜的部份當然是估價系統，由於櫥櫃的建立是透過選擇資料即時演算出來，更何況櫥櫃類的 BOM 表階層是怪物般的可怕...所以在 DB 的建置與前端資料整合的部分著實費了我們一番苦心。 [櫥櫃 BOM 表編輯視窗及櫥櫃 BOM 單物件材質指定] 此外，在 UI 設計上也特別花了一些心思。本案子 Target User 是管理者、店長與公司旗下的業務群，此公司成員年齡約 30-60 歲，皆為一般電腦使用者，所以 UI 設計及操作 Flow 必須比一般線上 RIA 更加友善，才能幫助縮減公司的人事教育花費。如放大整個系統的標準字 size；新增資料時不能碰的快速鍵會鎖定；產品類縮圖雙點擊即可觀看放大圖；操作 flow 皆以左上至右下結束以及利用畫面引導使用者操作都是一些設計上的巧思。 [新增估價單] [簡單易用的業務員用客戶系統] 此外這個專案在實作 PureMVC 過程當然是相當的快樂，因為它的彈性與權職切分實在太令人滿意了！不管是擴充性，Rich Data 管理又或者除錯都非常的容易。當然本人早就已經是 PureMVC 的忠實粉絲了...=P 快來加入 Flex + PureMVC 的行列吧~~ 結果這篇到最後變成 PureMVC 的勸進文...XD
10 comments
Read more