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

Comments

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

    ReplyDelete
  2. This comment has been removed by the author.

    ReplyDelete
  3. Erin大,你嵌入的附圖失效了喔~

    ReplyDelete
  4. 有沒有 flash builder 生成swc 的資料 ?妹妹

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

    ReplyDelete

Post a Comment

Popular posts from this blog

[Unity] erinylin.lazylib - Cookie for PlayerPrefs

有鑑於 PlayerPrefs 測試與版本更新問題,將大家都愛用的 PreviewLabs.PlayerPrefs 打包起來,製作重點還是以懶人為主,基本上 PlayerPrefs 資料更新與數量並不可能會有強烈衝擊效能的狀況產生,所以為了方便開發,就弄了一個視覺化工具,方便除錯用。

雖然 PreviewLabs.PlayerPrefs 作者都宣告放棄他們的版權,不過為了尊重程式,僅僅加入了兩個公用函式,其他並無更改。

內有:
Cookie ManagerCookie 用 DataObject 混合編輯 ScriptableObject執行階段除錯視窗工具當然還是有懶人常數檔案輸出資料版本控制,方便更新版後儲存資料更新功能其實很多,有興趣的請自行到 Github 下載並參考範例吧!

PureMVC 我也會 [1]

為什麼要學 PureMVC ? 明明網路上一堆免費的 MVC 微型框架,為什麼 Erin 特別愛用 PureMVC?
嚴格說起來,使用 PureMVC 開發的專案寫出來的 class 檔一定比 一些簡化版 PureMVC base 的 framework 如 Robotlegs 多,也比較難入門,但是為什麼要特別推薦它?

答案很簡單,越基本的東西反而是最好延伸,留白越多的紙最好畫!也因為如此才令人著迷啊...(咦?)

百分百真情推薦:
大家的職責切分的很乾淨...棒訊息傳遞機制是好物由於架構超然於 Flash / Flex 架構上,反而在 team work 分工的時候更方便擁有多個程式語言的版本,想要入門其他語言是個不錯的選擇Source code 公開化,要改要加什麼隨便你~~出來的時間比較久相關資源多
接下來就來看圖說故事。
PureMVC Diagram, 出處:PureMVC 官網

當初第一眼看到這張圖的時候,真的挺像個變形蟲,不過想要快速了解 framework 的基本運作流程,最容易的方法就是看圖說故事...

PureMVC 核心是由四個單例(singleton design pattern) 組成: Facade, Model, View and Control,唯一出入口就是 Facade,你會發現圖示中 Model, View and Control 都是雙向指向連接到 Facade,它們互相不清楚其他人的存在。

這四個 Class 你也只需要認識 Facade 即可...=)

Facade :
圖示中, Facade 下方有三個圈圈分別是 Mediator, Command and Proxy,意思是所有實作這三種 class instance 都是透過 Façade 來註冊移除或取用其他資源。拿 Flash 來比喻, Facade 很像是 root,所有的 DisplayObject 顯示、操作和移除都可以透過 root 抓取實體後執行,所有實體都可以透過 root 去找到其他實體。在 PureMVC 中, 它最大的作用就是切開 MVC 彼此的依賴,也提供 user 一個統一的操作出入口。

Model, View and Control
你會發現這三個大圈圈旁邊都有一堆同色的 Proxy, Command and Mediator,當各自的 class inst…

[Mac app] 開啟 Mac OSX 中自帶的 Color Picker 並加上 HexColorPicker 功能

參考出處:Mac — Adding Hex Color Picker to Color Picker

Mac app store 上有很多 Color Picker app,差不多 98% 都是需要付費,而這個小工具恰恰是開發中不可缺少一個東西。其實 Mac OSX 中就有自帶一個 ColorPicker,秉持著 DIY 的精神,用幾個小步驟就可以組合出顯示 Hex 色碼的 ColorPicker.app。

Mac 系統需求:10.4 and up