ActionScript的API文檔生成工具ASDoc

2020-07-17 13:18:08

字體：大中小

供稿：網(wǎng)友

運用ASDoc工具
原文地址: http://livedocs.adobe.com/flex/3/html/asdoc_9.html
譯者注：
ASDoc是adobe官方提供的ActionScript的API文檔生成工具，現(xiàn)在已經(jīng)集成在FlexBuilder3中
打開ASDoc工具的方法：
1.安裝FlexBuilder3后，
打開開始—>程序—>Adobe—>Adobe Flex 3 SDK Command Prompt
2.此時會進入cmd命令行界面，用cd命令進入你的工程目錄下
例如我的工程目錄是E:/flexwork
當(dāng)前是cmd指向在C:/Program Files/Adobe/FLexBuilder3/
3.首先輸入 E:進入E:/
然后輸入 cd flexwork
屏幕顯示E:/flexwork/> 后即可使用asdoc命令編譯API文檔了
編譯后的asdoc文檔會在E:/flexwork/路徑下輸出一個asdoc-output文件夾，運行里面的index.html就是API文檔主頁
你可以使用以下的ASDoc命令參數(shù)來制定類文件列表
doc-classes doc-sourcess doc-namespaces
doc-classes和doc-namespaces要求用source-path指定類文件文件所在的根目錄
如下是一個最基本的列子，用doc-classes參數(shù)指定類文件列表：
asdoc –source-path . –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo
這個例子中，類文件必須是comps/GraphingWidget.as和comps/GraphingWidgetTwo.as,并且comps必須是位于運行asdoc命令所在位置下的一個子文件夾。doc-classes的參數(shù)中用‘.’對應(yīng)類所在的包(package)名
譯者注：如果類文件就在當(dāng)前目錄下，source-pathh參數(shù)后面的內(nèi)容需要填寫’.’
如果類文件沒有在當(dāng)前目錄下，可以用source-path參數(shù)指定該目錄。
下面的例子，如果兩個類文件在C:/flex/class_dir/comps下，可以像這樣使用asdoc命令：
asdoc –source-path C:/flex/class_dir/comps –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo
如果你的程序里引用了包含有swc文件的庫。
在下例中，可以使用 –library-path參數(shù)指定要包含的swc文件：
asdoc –source-path . –doc-classes myComponents.BlueButton –library-path C:/myLibs
用 doc-sources參數(shù)可以指定源文件夾。通過該參數(shù)，asdoc會遞歸搜尋目錄。
下面的命令會生成當(dāng)前目錄及其子目錄下所有的類：
asdoc –source-path . –doc-sources
用 doc-namespaces參數(shù)可以指定要輸出的命名空間。
下面的命令會把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參數(shù)指定的類不會輸出類中包含了@private標(biāo)簽的不會被輸出 SWC中的類，不會被輸出以下的例子中，會輸出當(dāng)前目錄及其子目錄下所有類文件，除了comps/PageWidget 和 comps/ScreenWidget.as：
asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget comps.ScreenWidget
注意：
這些被排除的類，仍然會同其他類一樣被編譯，只是內(nèi)容不會被輸出
如果將exclude-dependecies參數(shù)設(shè)為true，當(dāng)編譯類時所依賴的相關(guān)類不會被輸出。
該參數(shù)默認值是false，意味著所有與指定類相關(guān)聯(lián)的類都會被正常輸出成文檔。
例如：你用doc-classes指定了類A,如果類A中 import了類B，那么類A和類B都會被輸出。

上一篇：Flash游戲開發(fā)教程：第七節(jié)

下一篇：Flash游戲開發(fā)教程：第八節(jié)