在FlexBuilder3中自帶了asDoc(Doc生成工具). asDoc.exe的位置在../Flex Builder 3 Plug-in/sdks/3.0.0/bin下
使用FlexBuilder3中的External Tools 運(yùn)行asdoc.exe,具體配置如下:
1.點(diǎn)擊eclise工具按鈕中的 open External Tools Dialog...
2.右鍵點(diǎn)擊Program 新建
3.配置asDoc路徑,源代碼路徑,以及生成時(shí)所需要的參數(shù).
4.點(diǎn)擊Apply然后Run就可以在你項(xiàng)目中的src目錄下生成 blueonlyDocs的文件夾,里面就是所生成的doc,這樣就大功告成了.
需要注意的是:
1.如果你的注釋中包括中文,或者其他的非英文的語(yǔ)言,你需要在Common中設(shè)置它的編碼格式UTF8:
2.如果您的代碼中引用了AIR所需的類或者接口,生成的過(guò)程會(huì)報(bào)錯(cuò),你需要在參數(shù)中添加AIR的swc路徑,官方的方法是:
../bin/asdoc -doc-sources C:/myApplication/myComponents/MyAirComboBox.as -library-path+=../frameworks/libs/air -main-title "My AIR API Documentation" -window-title "My AIR API Documentation" -output air-asdoc
This command assumes the following:
- You run the command from the directory C:/Program Files/Adobe/Flex Builder 3/sdks/3.0.0/asdoc in your Flex Builder installation directory structure. If you are using the Flex SDK, or have installed Flex Builder on another operating system, modify the paths in this command as necessary.
- The AIR SWC files are installed in the directory C:/Program Files/Adobe/Flex Builder 3/sdks/3.0.0/frameworks/libs/air. This is the default directory location for a Flex Builder installation. This command uses the library-path option to the ASDoc tool to specify the directory location of the AIR SWC files. The"+=" operator to the -library-path option specifies to append the AIR SWC files to the Flex SWC files.
- The ASDoc tool writes the output to the directory C:/Program Files/Adobe/Flex Builder 3/sdks/3.0.0/asdoc/air-asdoc.
但是我怎么試也不好用,如果哪位高手會(huì)的話請(qǐng)告訴我,我的方法是直接把
../frameworks/libs/air
下的所有文件copy到../frameworks/libs中,這樣不用添加任何參數(shù)就可以編譯運(yùn)行.
好了,今天就寫這么多了,祝您好運(yùn),以下附上我自己生成的Doc:
運(yùn)用ASDoc工具
原文地址:
http://livedocs.adobe.com/flex/3/html/asdoc_9.html
譯者注
:
ASDoc是adobe官方提供的ActionScript的API文檔生成工具,現(xiàn)在已經(jīng)集成在FlexBuilder3中
打開(kāi)ASDoc工具的方法:
1.安裝FlexBuilder3后,
打開(kāi) 開(kāi)始—>程序—>Adobe—>Adobe Flex 3 SDK Command Prompt
2.此時(shí)會(huì)進(jìn)入cmd命令行界面,用cd命令進(jìn)入你的工程目錄下
例如我的工程目錄是E:/flexwork
當(dāng)前是cmd指向在C:/Program Files/Adobe/FLexBuilder3/
3.首先輸入 E:進(jìn)入E:/
然后 輸入 cd flexwork
屏幕顯示E:/flexwork/> 后即可使用asdoc命令編譯API文檔了
編譯后的asdoc文檔會(huì)在E:/flexwork/路徑下輸出一個(gè)asdoc-output文件夾,運(yùn)行里面的index.html就是API文檔主頁(yè)
你可以使用以下的ASDoc命令參數(shù)來(lái)制定類文件列表
doc-classes doc-sourcess doc-namespaces
doc-classes和doc-namespaces要求用source-path指定類文件文件所在的根目錄
如下是一個(gè)最基本的列子,用doc-classes參數(shù)指定類文件列表:
asdoc –source-path . –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo
這個(gè)例子中,類文件必須是comps/GraphingWidget.as和comps/GraphingWidgetTwo.as,并且comps必須是位于運(yùn)行asdoc命令所在位置下的一個(gè)子文件夾。doc-classes的參數(shù)中用‘.’對(duì)應(yīng)類所在的包(package)名
譯者注:如果類文件就在當(dāng)前目錄下,source-pathh參數(shù)后面的內(nèi)容需要填寫’.’
如果類文件沒(méi)有在當(dāng)前目錄下,可以用source-path參數(shù)指定該目錄。
下面的例子,如果兩個(gè)類文件在C:/flex/class_dir/comps下,可以像這樣使用asdoc命令:
asdoc –source-path C:/flex/class_dir/comps –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo
如果你的程序里引用了包含有swc文件的庫(kù)。
在下例中,可以使用 –library-path參數(shù)指定要包含的swc文件:
asdoc –source-path . –doc-classes myComponents.BlueButton –library-path C:/myLibs
用 doc-sources參數(shù)可以指定源文件夾。通過(guò)該參數(shù),asdoc會(huì)遞歸搜尋目錄。
下面的命令會(huì)生成當(dāng)前目錄及其子目錄下所有的類:
asdoc –source-path . –doc-sources
用 doc-namespaces參數(shù)可以指定要輸出的命名空間。
下面的命令會(huì)把core framework下的所有類文件輸出成文檔:
asdoc -source-path frameworks -namespace
http://framework
frameworks/core-framework-manifest.xml -doc-namespaces
http://framework
排除類文件
用doc-classes, doc-sources和 doc-namespaces命令輸出所有的類文件時(shí),
會(huì)有以下三點(diǎn)例外:
- 用exclude-classes參數(shù)指定的類不會(huì)輸出
- 類中包含了@private標(biāo)簽的不會(huì)被輸出
- SWC中的類,不會(huì)被輸出
以下的例子中,會(huì)輸出當(dāng)前目錄及其子目錄下所有類文件,除了comps/PageWidget 和 comps/ScreenWidget.as:
asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget comps.ScreenWidget
注意:
這些被排除的類,仍然會(huì)同其他類一樣被編譯,只是內(nèi)容不會(huì)被輸出
如果將exclude-dependecies參數(shù)設(shè)為true,當(dāng)編譯類時(shí)所依賴的相關(guān)類不會(huì)被輸出。
該參數(shù)默認(rèn)值是false,意味著所有與指定類相關(guān)聯(lián)的類都會(huì)被正常輸出成文檔。
例如:你用doc-classes指定了類A,如果類A中 import了類B,那么類A和類B都會(huì)被輸出。
asdoc命令參數(shù)列表 :
asdoc命令參數(shù)使用方法等同于mxmlc和compc
更多的mxmlc和comp信息,參見(jiàn)
Using the flex Compilers
參數(shù)功能列表如下 :
Option | Description |
-doc-classes path-element [...] |
指定需要被輸出成文檔的類文件,這些類文件必須放在資源路徑下[默認(rèn)參數(shù)]
該參數(shù)使用方法等同于compc組件編譯器的-include-classes參數(shù),更多信息參見(jiàn) Using compc, the component compiler |
-doc-namespaces uri manifest |
要求被輸出成文檔的類文件URIs列表,這些類文件必須放在資源路徑下。
必須包含至少一個(gè)URI并指出命名空間內(nèi)容的明確位置 該參數(shù)使用方法等同于compc組件編譯器的-include-namespaces參數(shù),更多信息參見(jiàn) Using compc, the component compiler |
-doc-sources path-element [...] |
需要被輸出成文檔的文件目錄,并且其子目錄也會(huì)被遞歸輸出
該參數(shù)使用方法等同于compc組件編譯器的-include-sources參數(shù),更多信息參見(jiàn) Using compc, the component compiler |
exclude-classes string |
不需要被輸出的類文件列表,必須指定類名
或者, 該類中的ASDoc命令里包含了 @private 標(biāo)簽,同樣也不會(huì)被輸出 -exclude-dependencies true|false 決定是否所有的相關(guān)類都會(huì)輸出,如果設(shè)true,與輸出類相關(guān)的類不回被輸出。默認(rèn)值為false |
-footer string | 文檔中HTML頁(yè)面底部的顯示信息 |
-left-frameset-width int |
控制文檔左邊目錄寬度的整數(shù)值。你可以根據(jù)你的包名來(lái)改變這個(gè)值
默認(rèn)值是210px |
-main-title "string" |
文檔中HTML頁(yè)面頭部顯示信息
默認(rèn)值是"API Documentation". |
-output string | 輸出文檔的目錄名. 默認(rèn)值 "asdoc-output". |
-package name "description" |
輸出文檔中對(duì)應(yīng)的包名。你可以指定一個(gè)以上的包
下例中,輸出了兩個(gè)包: 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模板目錄的路徑. 默認(rèn)值是ASDoc 安裝目錄下的asdoc/templates。該目錄包含了用于輸出成文檔的所有的HTML, CSS, XSL文件image |
-window-title "string" |
文檔中瀏覽器頂部顯示信息
默認(rèn)值是"API Documentation". |
以下asdoc命令適用于compc組件編譯器:
- -source-path
- -library-path
- -namespace
- -load-config
- -actionscript-file-encoding
- -help
- -advanced
- -benchmark
- -strict
- -warnings
更多信息,參見(jiàn) Using mxmlc, the application compiler 還有很多其他程序編譯參數(shù)可以使用,這里不再詳加闡述,在ASDoc tool中你可以像使用mxmlc and compc一樣使用同樣的命令構(gòu)造文件。
更多文章、技術(shù)交流、商務(wù)合作、聯(lián)系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號(hào)聯(lián)系: 360901061
您的支持是博主寫作最大的動(dòng)力,如果您喜歡我的文章,感覺(jué)我的文章對(duì)您有幫助,請(qǐng)用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點(diǎn)擊下面給點(diǎn)支持吧,站長(zhǎng)非常感激您!手機(jī)微信長(zhǎng)按不能支付解決辦法:請(qǐng)將微信支付二維碼保存到相冊(cè),切換到微信,然后點(diǎn)擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對(duì)您有幫助就好】元
