運用ASDoc工具
原文地址: http://livedocs.adobe.com/flex/3/html/asdoc_9.html
譯者注：
ASDoc是adobe官方提供的ActionScript的API文檔生成工具，現在已經集成在FlexBuilder3中
打開ASDoc工具的方法：
1.安裝FlexBuilder3後，
打開 開始—>程序—>Adobe—>Adobe Flex 3 SDK Command Prompt
2.此時會進入cmd命令行界面，用cd命令進入你的工程目錄下
例如我的工程目錄是E:/flexwork
當前是cmd指向在C:/Program Files/Adobe/FLexBuilder3/
3.首先輸入 E:進入E:/
然後 輸入 cd flexwork
屏幕顯示E:/flexwork/> 後即可使用asdoc命令編譯API文檔了
編譯後的asdoc文檔會在E:/flexwork/路徑下輸出一個asdoc-output文件夾，運行裏面的index.html就是API文檔主頁
你可以使用以下的ASDoc命令參數來制定類文件列表
doc-classes doc-sourcess doc-namespaces
doc-classes和doc-namespaces要求用source-path指定類文件文件所在的根目錄
如下是一個最基本的列子，用doc-classes參數指定類文件列表：
asdoc –source-path . –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo
這 個例子中，類文件必須是comps/GraphingWidget.as和comps/GraphingWidgetTwo.as,並且comps必須是 位於運行asdoc命令所在位置下的一個子文件夾。doc-classes的參數中用‘.’對應類所在的包(package)名
譯者注：如果類文件就在當前目錄下，source-pathh參數後面的內容需要填寫’.’
如果類文件沒有在當前目錄下，可以用source-path參數指定該目錄。
下面的例子，如果兩個類文件在C:/flex/class_dir/comps下，可以像這樣使用asdoc命令：
asdoc –source-path C:/flex/class_dir/comps –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo
如果你的程序裏引用了包含有swc文件的庫。
在下例中，可以使用 –library-path參數指定要包含的swc文件：
asdoc –source-path . –doc-classes myComponents.BlueButton –library-path C:/myLibs
用 doc-sources參數可以指定源文件夾。通過該參數，asdoc會遞歸搜尋目錄。
下面的命令會生成當前目錄及其子目錄下所有的類：
asdoc –source-path . –doc-sources
用 doc-namespaces參數可以指定要輸出的命名空間。
下面的命令會把core framework下的所有類文件輸出成文檔：
asdoc -source-path frameworks -namespace http://framework frameworks/core-framework-manifest.xml -doc-namespaces http://framework
排除類文件
用doc-classes, doc-sources和 doc-namespaces命令輸出所有的類文件時，
會有以下三點例外：
用exclude-classes參數指定的類不會輸出
類中包含了@private標籤的不會被輸出
SWC中的類，不會被輸出
以下的例子中，會輸出當前目錄及其子目錄下所有類文件，除了comps/PageWidget 和 comps/ScreenWidget.as：
asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget comps.ScreenWidget
注意：
這些被排除的類，仍然會同其他類一樣被編譯，只是內容不會被輸出
如果將exclude-dependecies參數設爲true，當編譯類時所依賴的相關類不會被輸出。
該參數默認值是false，意味着所有與指定類相關聯的類都會被正常輸出成文檔。
例如：你用doc-classes指定了類A,如果類A中 import了類B，那麼類A和類B都會被輸出。
asdoc命令參數列表：
asdoc命令參數使用方法等同於mxmlc和compc
更多的mxmlc和comp信息，參見 Using the flex Compilers
參數功能列表如下：
| Option | Description |
| -doc-classes path-element [...] | 指定需要被輸出成文檔的類文件，這些類文件必須放在資源路徑下[默認參數] 該參數使用方法等同於compc組件編譯器的-include-classes參數，更多信息參見 Using compc, the component compiler |
| -doc-namespaces uri manifest | 要求被輸出成文檔的類文件URIs列表，這些類文件必須放在資源路徑下。 必須包含至少一個URI並指出命名空間內容的明確位置 該參數使用方法等同於compc組件編譯器的-include-namespaces參數，更多信息參見Using compc, the component compiler |
| -doc-sources path-element [...] | 需要被輸出成文檔的文件目錄，並且其子目錄也會被遞歸輸出 該參數使用方法等同於compc組件編譯器的-include-sources參數，更多信息參見Using compc, the component compiler |
| exclude-classes string | 不需要被輸出的類文件列表，必須指定類名 或者， 該類中的ASDoc命令裏包含了 @private 標籤，同樣也不會被輸出 -exclude-dependencies true|false 決定是否所有的相關類都會輸出，如果設true，與輸出類相關的類不回被輸出。默認值爲false |
| -footer string | 文檔中HTML頁面底部的顯示信息 |
| -left-frameset-width int | 控制文檔左邊目錄寬度的整數值。你可以根據你的包名來改變這個值 默認值是210px |
| -main-title "string" | 文檔中HTML頁面頭部顯示信息 默認值是"API Documentation". |
| -output string | 輸出文檔的目錄名. 默認值 "asdoc-output". |
| -package name "description" | 輸出文檔中對應的包名。你可以指定一個以上的包 下例中，輸出了兩個包： asdoc -doc-sources my_dir -output myDoc -package com.my.business "Contains business classes and interfaces" -package com.my.commands "Contains command base classes and interfaces" |
| -templates-path string | ASDoc模板目錄的路徑. 默認值是ASDoc 安裝目錄下的asdoc/templates。該目錄包含了用於輸出成文檔的所有的HTML, CSS, XSL文件image |
| -window-title "string" | 文檔中瀏覽器頂部顯示信息 默認值是"API Documentation". |
以下asdoc命令適用於compc組件編譯器:
-source-path
-library-path
-namespace
-load-config
-actionscript-file-encoding
-help
-advanced
-benchmark
-strict
-warnings
更多信息，參見 Using mxmlc, the application compiler 還有很多其他程序編譯參數可以使用，這裏不再詳加闡述，在ASDoc tool中你可以像使用mxmlc and compc一樣使用同樣的命令構造文件。
文章來自: 閃客居(www.flashas.net) 詳文參考：http://www.flashas.net/html/FLASHfuzhuruanjian/20090106/3877.html