一.YUIDoc概述以及安裝
YUIDoc是為YUI　Library用來(lái)生成HTML版API文檔的一系列工具集，文檔的生成完全基于JavaDoc風(fēng)格的代碼注釋規(guī)則。該工具是基于Python語(yǔ)言編寫(xiě)，并且使用了幾個(gè)基于Python的擴(kuò)展組件作為底層支持，如讀寫(xiě)json對(duì)象、HTML模板管理以及源代碼著色等等。所以在使用YUIDoc之前，請(qǐng)確保你的機(jī)器上已經(jīng)安裝了Python環(huán)境和YUIDoc所依賴(lài)的Python擴(kuò)展組件，詳述如下：

• Python 2.3+?
• simplejson?- 提供讀寫(xiě)json對(duì)象支持（Python擴(kuò)展）
• cheetah???? - 為生成HTML文檔提供模板支持（Python擴(kuò)展）
• pygments? - 源代碼著色工具（Python擴(kuò)展）

（tips: 如果你對(duì)Python語(yǔ)言不熟，那也沒(méi)有關(guān)系，python擴(kuò)展的安裝方法是非常簡(jiǎn)單的。如果是Windows環(huán)境，首先為Python設(shè)置一下環(huán)境變量Path，即向環(huán)境變量Path上追加C:\Python26,也就是Python默認(rèn)的安裝路徑；接下來(lái)解壓每一個(gè)擴(kuò)展組件，在文件夾中你會(huì)發(fā)現(xiàn)一個(gè)setup.py的文件，運(yùn)行DOS，切換到解壓后的目錄下（或者setup.py所在的目錄下），輸入python setup.py install即可搞定大多數(shù)擴(kuò)展組件的安裝:P)
不過(guò)，安裝simplejson的時(shí)候會(huì)有一點(diǎn)點(diǎn)小麻煩，即該擴(kuò)展庫(kù)依賴(lài)于另一個(gè)python擴(kuò)展setuptools，下載完組件的egg文件（我下載的叫setuptools-0.6c7-py2.6.egg）后直接放到simplejson的setup.py同一路徑下，按照上面介紹的命令再次運(yùn)行setup.py，安裝成功。
二. YUIDoc的簡(jiǎn)單使用方法
使用命令：yuidoc.py inputdir [options] inputdir
(其中options可以通過(guò)以下命令來(lái)獲取幫助：yuidoc.py --help)
這里有以下幾點(diǎn)需要注意

• 可選參數(shù)和跟在后面的輸入目錄（inputdir）是成對(duì)出現(xiàn)的，如設(shè)置文檔輸出路徑 -o E:\outputs
• 可選參數(shù)“模板路徑”一定要給定，經(jīng)測(cè)試，如不給定模板路徑，文檔生成失敗（引發(fā)WindowError）

所以最后的參考使用命令為：
python yuidoc.py E:\libdir -t E:\template -o E:\outputs
其中，
E:\libdir路徑存放所有的具有良好注釋的JavaScript文件，yuidoc會(huì)搜索該目錄下的所有JavaScript文件
E:\template路徑存放HTML模板，具體請(qǐng)參考yuidoc目錄下的template文件夾
E:\outputs路徑是yuidoc將生成完的HTML幫助文檔存放的路徑
好了，所有的安裝和基本使用方法就是這些。如果你的JavaScript文檔符合yuidoc所規(guī)定的注釋規(guī)范，并且命令執(zhí)書(shū)寫(xiě)正確，那么正確的JavaScript文檔就會(huì)出現(xiàn)在你眼前！
Enjoy！！！

總結(jié)

以上是生活随笔為你收集整理的YUIDoc的使用方法小结的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。