一.YUIDoc概述以及安裝
YUIDoc是為YUI　Library用來生成HTML版API文檔的一系列工具集，文檔的生成完全基于JavaDoc風格的代碼注釋規則。該工具是基于Python語言編寫，并且使用了幾個基于Python的擴展組件作為底層支持，如讀寫json對象、HTML模板管理以及源代碼著色等等。所以在使用YUIDoc之前，請確保你的機器上已經安裝了Python環境和YUIDoc所依賴的Python擴展組件，詳述如下：

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

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

• 可選參數和跟在后面的輸入目錄（inputdir）是成對出現的，如設置文檔輸出路徑 -o E:\outputs
• 可選參數“模板路徑”一定要給定，經測試，如不給定模板路徑，文檔生成失敗（引發WindowError）

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

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。