ActionScript的API文檔生成工具ASDoc
互聯(lián)網(wǎng) 發(fā)布時(shí)間:2008-10-06 01:25:38 作者:佚名
我要評(píng)論
運(yùn)用ASDoc工具
原文地址: http://livedocs.adobe.com/flex/3/html/asdoc_9.html
譯者注:
ASDoc是adobe官方提供的ActionScript的API文檔生成工具,現(xiàn)在已經(jīng)集成在FlexBuilder3中
打開ASDoc工具的方法:
1.安裝FlexBuilder3后,
打開 開始—>程序—>Adobe&
asdoc命令參數(shù)列表:
asdoc命令參數(shù)使用方法等同于mxmlc和compc
更多的mxmlc和comp信息,參見 Using the flex Compilers
參數(shù)功能列表如下:
Option Description -doc-classes path-element [...] 指定需要被輸出成文檔的類文件,這些類文件必須放在資源路徑下[默認(rèn)參數(shù)]
該參數(shù)使用方法等同于compc組件編譯器的-include-classes參數(shù),更多信息參見 Using compc, the component compiler -doc-namespaces uri manifest 要求被輸出成文檔的類文件URIs列表,這些類文件必須放在資源路徑下。
必須包含至少一個(gè)URI并指出命名空間內(nèi)容的明確位置
該參數(shù)使用方法等同于compc組件編譯器的-include-namespaces參數(shù),更多信息參見Using compc, the component compiler -doc-sources path-element [...] 需要被輸出成文檔的文件目錄,并且其子目錄也會(huì)被遞歸輸出
該參數(shù)使用方法等同于compc組件編譯器的-include-sources參數(shù),更多信息參見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 更多信息,參見 Using mxmlc, the application compiler還有很多其他程序編譯參數(shù)可以使用,這里不再詳加闡述,在ASDoc tool中你可以像使用mxmlc and compc一樣使用同樣的命令構(gòu)造文件。
相關(guān)文章

flash cs6鼠標(biāo)跟隨效果實(shí)現(xiàn)代碼分享
flash cs6想要實(shí)現(xiàn)鼠標(biāo)跟隨效果?該怎么制作呢?今天我們就來(lái)看看使用as2.0實(shí)現(xiàn)鼠標(biāo)跟隨效果的教程,需要的朋友可以參考下2019-05-19
Flash cs6怎么使用代碼輸入中英文文本?Flash cs6中可以使用文字工具直接輸入文本,也可以使用代碼來(lái)輸入文本,該怎么使用代碼輸入文本呢?請(qǐng)看下文詳細(xì)的教程,需要的朋友2018-03-11
flash as3.0抽象類怎么定義? as3.0中有很多抽象類,該怎么定義抽象類和抽象方法呢?下面我們就來(lái)看看簡(jiǎn)單的例子,需要的朋友可以參考下http://www.fzitv.net/softs/408402.2018-02-28
flash cs6中怎么使用ActionScript3.0?
flash cs6中怎么使用ActionScript3.0?flash cs6中想要使用ActionScript3.0功能,該怎么使用呢?下面我們就來(lái)看看詳細(xì)的教程,需要的朋友可以參考下2018-01-25
Flash中怎么實(shí)現(xiàn)鼠標(biāo)點(diǎn)擊決定圖像位置?
本教程給大家分享一個(gè)Flash小教程,教大家在Flash CS6中怎么實(shí)現(xiàn)鼠標(biāo)點(diǎn)擊決定圖像位置?方法很簡(jiǎn)單,感興趣的朋友歡迎前來(lái)一起分享學(xué)習(xí)2018-01-12
Flash中如何用代碼將圖片放在自己想要的舞臺(tái)位置?
本教程教腳本之家的ActionScript教程學(xué)習(xí)者在Flash中如何用代碼將圖片放在自己想要的舞臺(tái)位置,教程講解的詳細(xì),感興趣的朋友歡迎前來(lái)分享學(xué)習(xí)2017-11-20
在Flash CS6中使用with函數(shù)繪制背景圖教程
本教程教腳本之家的ActionScript教程學(xué)習(xí)者如何在Flash CS6中使用with函數(shù)繪制背景圖?教程一步步講解的挺詳細(xì),方法也不難,非常適合Flash新手入門學(xué)習(xí)2017-11-18
Flash怎么設(shè)置元件坐標(biāo)?flash使用代碼設(shè)置元件的坐標(biāo)的教程
Flash怎么設(shè)置元件坐標(biāo)?flash中導(dǎo)如的元件需要添加坐標(biāo),該怎么定位元件坐標(biāo)呢?下面我們就來(lái)看看flash使用代碼設(shè)置元件的坐標(biāo)的教程,需要的朋友可以參考下2017-10-11
Flash怎么制作來(lái)回?fù)u擺的花朵的動(dòng)畫?
Flash怎么制作來(lái)回?fù)u擺的花朵的動(dòng)畫?Flash中想要給花朵制作一段搖擺的動(dòng)畫效果,該怎么制作呢?下面我們就來(lái)看看詳細(xì)的教程,很簡(jiǎn)單,需要的朋友可以參考下2017-05-23
Flash怎么制作流動(dòng)七彩色的文字?想要讓文字動(dòng)起來(lái),該怎么使用flash給文字制作一個(gè)流動(dòng)七彩色的動(dòng)畫呢?下面我們就來(lái)看看詳細(xì)的教程,需要的朋友可以參考下2017-04-23











