Flash Builder 4.6配置ASDoc

ASDoc是Adobe自帶的文檔生成工具。能夠生成相似JavaDoc格式的文檔。

關於ASDoc詳情參見官方文檔： http://help.adobe.com/zh_CN/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bb7b-7fe7.html。

要想使用ASDoc工具來生成項目API文檔， 能夠使用命令行 ，也能夠在FlashBuilder中來添加外部工具及配置相應的參數來完成。

本文介紹第二種方式。實質上第二種方式和第一種方式執行的原理是同樣的，只是第二種方式配置界面化了，方便咱們執行。

一、打開Flash Builder後，Run -> External Tools -> External Tools Configurations..，如圖：

二、在彈出的界面中，選中Program，點擊添加圖標添加外部程序。

三、在彈出的外部程序信息配置中，添加相應的信息。

Location：ASDoc.exe所在的路徑。該程序在Flash Builder安裝目錄 ../Adobe Flash Builder 4.6/sdks/4.6.0/bin/asdoc.exe。

Working Directory：能夠瀏覽工做區的目錄，也能夠選擇文件系統的目錄或者使用變量。

Arguments：ASDoc生成文檔的參數。如下選擇Working Directory目錄下的src做爲源目錄，輸出到 Working Directory目錄下的doc目錄

    
    
    
    

     
     
     
     

     
     
     
     

     
     
     
     

     
     
     
     

    
    
    
    
-source-path src -doc-sources src-output doc-main-title "D5 Power API doc"

四、支持中文註釋

選擇Common選項卡，在Encoding中選擇Other，而後選擇UTF-8。如圖：

操做完以後，點擊Apply按鈕，而後點擊 Run按鈕，生成項目的文檔。

常見錯誤

1. Error： could not find JRE  

解決辦法：

找到文件Adobe Flash Builder 4.5\sdks\4.5.0\bin\jvm.config

而後鍵入你的JRE的安裝目錄，做爲java.home的變量，假設你的java安裝你的根目錄下的話，那麼鍵入：

java.home=C:/Program Files/Adobe/Adobe Flash Builder 4.5/jre   //注意文件分隔符 是'/'，即反斜槓

注意：是JRE文件夾目錄，而不是JDK目錄。確保其中的jre文件夾下的bin目錄中要有java.dll文件。

2. FlashBuilder 使用ASdoc亂碼問題

解決辦法：

找到文件Adobe Flash Builder 4.5\sdks\4.5.0\bin\jvm.config，在java.args=那行後面修改成:

java.args=-Xmx384m -Dsun.io.useCanonCaches=false -Dfile.encoding=utf-8 -Dsun.jnu.encoding=utf-8

3. 元素的內容必須由格式正確的字符數據或標記組成。

解決辦法：

其餘問題參見網絡吧

http://bbs.9ria.com/thread-116151-1-1.html

http://help.adobe.com/zh_CN/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ffa.html

http://help.adobe.com/zh_CN/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bb7b-7fed.html#WSd0ded3821e0d52fe1e63e3d11c2f44bb7b-7ff6

來自爲知筆記(Wiz)