YUIDoc的使用方法小結

一.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: emplate -o E:outputs
其中，
E:libdir路徑存放所有的具有良好註釋的JavaScript檔案，yuidoc會搜尋該目錄下的所有JavaScript檔案
E: emplate路徑存放HTML模板，具體請參考yuidoc目錄下的template資料夾
E:outputs路徑是yuidoc將生成完的HTML幫助文件存放的路徑
好了，所有的安裝和基本使用方法就是這些。如果你的JavaScript文件符合yuidoc所規定的註釋規範，並且命令執書寫正確，那麼正確的JavaScript文件就會出現在你眼前！
Enjoy！！！