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

[Flex] PureMVC standard with Spring extensions

由於上次稍微玩了一下 Robotlegs 依賴注入（DI） 主導的 MVC 框架，而著名也使用依賴注入的 Java / Java EE 的 Spring framework 出了 for ActionScript 的版本，剛好在最近 Spring ActionScript 1.0 正式 release 了（想了解 Spring 是啥咪東東的話請自行找 google 大神），這個版本除了基本框架外，也包含了 Cairngorm 與 PureMVC 的外掛...想當然耳，就拿來測試一下用在 PureMVC 內的感覺囉!! 參考了 官方範例 中 PureMVC 唯二的範例原始檔，以下使用的是「設定檔依賴注入 facade 透過 addConfigSource() 的方式來 init 」：(其實除了 embed 外，都是外部載入) Online Demo with source code 工作環境：FlashBuilder, Flex SDK4 請下載 PureMVC Standard 版本 再下載 Spring ActionScript 最新版本後，除了 spring-actionscript-cairngorm 不需要外，都放到 /src 下（記得只需要 org 開始...)，也別忘了lib 內的 swc 檔 copy 到 /libs 下 Spring 的 injection 並不像 Robotlegs 直接來個 [Inject] metadata 的自動化那樣方便，但是其冷血度（檔案的鬆偶程度）更勝後者！如果你要使用設定檔（applicationContext.xml) 來做注入的話，準備工作就挺多的...XD 依照 applicationContext.xml 內設定的方式分別寫入 constructor 或者是 setter 依賴注入（本範例統一使用 setter injection) 為了跟大家都沒關係所以都使用 interface 來處理，所以你會在範例中發現大家都有介面...(並沒有真的研究過 Spring，也許還有其他作法) 準備 compiler 時候要用的 classe。由於在 setter, getter 的寫法上都使用 interface，所以真正用到的 class 需要預先在輸出階段就打包到程式內。 基本上 PureMVC 類 class
2 comments
Read more

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