最近工作上需要把這幾個月研發(fā)的Flex Realspace產(chǎn)品在sp3時上線,急需制作幫助文檔,之前開發(fā)的時候注釋都是按著習慣性卸載代碼里面的,也沒有考慮后期的幫助文檔,這幾天愁啊,公司其他Flex產(chǎn)品用的是自己寫的帶包工具,我可沒那么多時間,查了很多資料,希望通過ASDoc達成愿望。
ASDoc是adobe官方提供的ActionScript的API文檔生成工具,早已經(jīng)集成在Flex Builder中,我使用的是Flex Builder4.6,使用方法如下;
1、首先配置一個生成文檔需要的環(huán)境,按照下面步驟
運行->外部工具->外部工具配置
點擊“新建啟動配置”,生成如下界面,填上如下信息:
名稱:隨意,這里我取的ASDoc。
位置:選擇你安裝目錄下asDoc.exe所在的路徑,我的是D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\bin\asdoc.exe
工作目錄:直接默認為${project_loc},這樣系統(tǒng)會從你當前打開的as類或mxml文件所在的項目作為默認輸出項目
自變量:這方面的參數(shù)網(wǎng)上資料很多,我這里不詳細說明
-source-path:代碼所在的目錄(不能用中文目錄)
-doc-sources:文件所在的目錄(不能用中文目錄)
-output: 輸出文檔的目錄(不能用中文目錄)
-external-library-path:擴展的Lib路徑(外部的swc的路徑)(不能用中文目錄)
-main-title 文檔首頁顯示的標題,這里我添加為 "SuperMap iClient 6R(2012) for Flex Realspace 幫助文檔"
這里我寫了如下三個,前兩個必須寫。
-source-path src
-doc-sources src
-main-title "SuperMap iClient 6R(2012) for Flex Realspace 幫助文檔"
2、文檔支持中文注釋
為了讓生成的文檔支持中文注釋,我們需要切換到“公共”,編碼->其他->選擇UTF-8。如下:
3、運行
點擊“應用”進行保存,我們可以直接點擊下面的運行,同時,在點擊應用的時候會在外部工具里面能生成一個快捷鍵,以后就很方便了,并且還可以再次修改。
最后控制臺出現(xiàn)如上信息表示生成成功,如果出現(xiàn)紅色字體,表示有錯誤,最常見的錯誤
[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.
是因為你的注釋某些地方有問題,比如標簽有沒有閉合,是不是用了一些特殊字符,比如>@、b>等等。 SDK4.x本身沒有錯誤,只是容錯性比較差,出錯提示也很爛,但是只要按規(guī)則寫,就可以通過。
成功后的文件如下的紅圈文件內(nèi)部:
點擊此文件里面的index.html可以查看生成的界面如下:
細心的讀者可能會發(fā)現(xiàn)自己生成的是全英文的,而我的是漢化版的,并且一些圖標都改了,找到你自己的flash builder的安裝目錄,在D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\asdoc下有一個文件夾叫templates,其實我們打包就是靠的這個文件夾里面的東西,我們公司自己做了一些修改,然后把這個文件替換了,就可以漢化了,并且支持了自己公司的圖標,有想要的可以留言,寫上自己的郵箱。
您可能感興趣的文章:- Flex幫助文檔(chm格式)制作及FAR的使用
- 輸入命令指令獲取幫助文檔的批處理
- simplehtmldom Doc api幫助文檔
- 最新的FlashCS3簡體中文幫助文檔chm提供下載了