日韩久久久精品,亚洲精品久久久久久久久久久,亚洲欧美一区二区三区国产精品 ,一区二区福利

使用asDoc生成自己的Flex API Document

系統 1760 0

在FlexBuilder3中自帶了asDoc(Doc生成工具). asDoc.exe的位置在../Flex Builder 3 Plug-in/sdks/3.0.0/bin下




使用FlexBuilder3中的External Tools 運行asdoc.exe,具體配置如下:
1.點擊eclise工具按鈕中的 open External Tools Dialog...



2.右鍵點擊Program 新建




3.配置asDoc路徑,源代碼路徑,以及生成時所需要的參數.



4.點擊Apply然后Run就可以在你項目中的src目錄下生成 blueonlyDocs的文件夾,里面就是所生成的doc,這樣就大功告成了.
需要注意的是:
1.如果你的注釋中包括中文,或者其他的非英文的語言,你需要在Common中設置它的編碼格式UTF8:



2.如果您的代碼中引用了AIR所需的類或者接口,生成的過程會報錯,你需要在參數中添加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.

但是我怎么試也不好用,如果哪位高手會的話請告訴我,我的方法是直接把 ../frameworks/libs/air 下的所有文件copy到../frameworks/libs中,這樣不用添加任何參數就可以編譯運行.
好了,今天就寫這么多了,祝您好運,以下附上我自己生成的Doc:





運用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一樣使用同樣的命令構造文件。

原文: http://www.blueidea.com/tech/multimedia/2008/6134.asp

使用asDoc生成自己的Flex API Document


更多文章、技術交流、商務合作、聯系博主

微信掃碼或搜索:z360901061

微信掃一掃加我為好友

QQ號聯系: 360901061

您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點擊下面給點支持吧,站長非常感激您!手機微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點擊微信右上角掃一掃功能,選擇支付二維碼完成支付。

【本文對您有幫助就好】

您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描上面二維碼支持博主2元、5元、10元、自定義金額等您想捐的金額吧,站長會非常 感謝您的哦!!!

發表我的評論
最新評論 總共0條評論
主站蜘蛛池模板: 平远县| 道真| 小金县| 桐城市| 常州市| 丰顺县| 潼南县| 科尔| 象州县| 信丰县| 旅游| 诏安县| 鄱阳县| 报价| 攀枝花市| 沙坪坝区| 抚顺县| 图木舒克市| 仙居县| 和田县| 凤城市| 长岛县| 商城县| 昌黎县| 年辖:市辖区| 蓝山县| 黔南| 察隅县| 舒兰市| 望江县| 荣成市| 仙桃市| 城口县| 佛山市| 兴化市| 瑞昌市| 西充县| 福贡县| 城口县| 平乡县| 工布江达县|