Flex幫助文檔(html格式)制作及ASDoc的使用

最近工作上需要把這幾個(gè)月研發(fā)的Flex Realspace產(chǎn)品在sp3時(shí)上線，急需制作幫助文檔，之前開發(fā)的時(shí)候注釋都是按著習(xí)慣性卸載代碼里面的，也沒有考慮后期的幫助文檔，這幾天愁啊，公司其他Flex產(chǎn)品用的是自己寫的帶包工具，我可沒那么多時(shí)間，查了很多資料，希望通過ASDoc達(dá)成愿望。

ASDoc是adobe官方提供的ActionScript的API文檔生成工具，早已經(jīng)集成在Flex Builder中，我使用的是Flex Builder4.6，使用方法如下；

1、首先配置一個(gè)生成文檔需要的環(huán)境，按照下面步驟

運(yùn)行->外部工具->外部工具配置

點(diǎn)擊“新建啟動(dòng)配置”，生成如下界面，填上如下信息：

名稱：隨意，這里我取的ASDoc。
位置：選擇你安裝目錄下asDoc.exe所在的路徑，我的是D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\bin\asdoc.exe
工作目錄：直接默認(rèn)為${project_loc}，這樣系統(tǒng)會(huì)從你當(dāng)前打開的as類或mxml文件所在的項(xiàng)目作為默認(rèn)輸出項(xiàng)目
自變量：這方面的參數(shù)網(wǎng)上資料很多，我這里不詳細(xì)說明
-source-path：代碼所在的目錄（不能用中文目錄）
-doc-sources：文件所在的目錄（不能用中文目錄）
-output： 輸出文檔的目錄（不能用中文目錄）
-external-library-path：擴(kuò)展的Lib路徑（外部的swc的路徑）（不能用中文目錄）
-main-title 文檔首頁顯示的標(biāo)題，這里我添加為 "SuperMap iClient 6R(2012) for Flex Realspace 幫助文檔"
這里我寫了如下三個(gè)，前兩個(gè)必須寫。
-source-path src
-doc-sources src
-main-title "SuperMap iClient 6R(2012) for Flex Realspace 幫助文檔"

2、文檔支持中文注釋

為了讓生成的文檔支持中文注釋，我們需要切換到“公共”，編碼->其他->選擇UTF-8。如下：

3、運(yùn)行

點(diǎn)擊“應(yīng)用”進(jìn)行保存，我們可以直接點(diǎn)擊下面的運(yùn)行，同時(shí)，在點(diǎn)擊應(yīng)用的時(shí)候會(huì)在外部工具里面能生成一個(gè)快捷鍵，以后就很方便了，并且還可以再次修改。

最后控制臺(tái)出現(xiàn)如上信息表示生成成功，如果出現(xiàn)紅色字體，表示有錯(cuò)誤，最常見的錯(cuò)誤

[Fatal Error] toplevel.xml:25186:244: The value of attribute "defaultValue" must not contain the '' character.

Error: Could not create toplevel.xml: The value of attribute "defaultValue" must not contain the '' character.

是因?yàn)槟愕淖⑨屇承┑胤接袉栴}，比如標(biāo)簽有沒有閉合，是不是用了一些特殊字符，比如>@、b>等等。 SDK4.x本身沒有錯(cuò)誤，只是容錯(cuò)性比較差，出錯(cuò)提示也很爛，但是只要按規(guī)則寫，就可以通過。

成功后的文件如下的紅圈文件內(nèi)部：

點(diǎn)擊此文件里面的index.html可以查看生成的界面如下：

細(xì)心的讀者可能會(huì)發(fā)現(xiàn)自己生成的是全英文的，而我的是漢化版的，并且一些圖標(biāo)都改了，找到你自己的flash builder的安裝目錄，在D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\asdoc下有一個(gè)文件夾叫templates，其實(shí)我們打包就是靠的這個(gè)文件夾里面的東西，我們公司自己做了一些修改，然后把這個(gè)文件替換了，就可以漢化了，并且支持了自己公司的圖標(biāo)，有想要的可以留言，寫上自己的郵箱。