Ant+JSDocTookit生成Javascript文檔

需要備上下面三樣東西

JSDocTookit

<a href="http://code.google.com/p/jsdoc-toolkit/">http://code.google.com/p/jsdoc-toolkit/</a>

JSDocTookit Ant Task

<a href="http://code.google.com/p/jsdoc-toolkit-ant-task/">http://code.google.com/p/jsdoc-toolkit-ant-task/</a>

Rhino

<a href="http://www.mozilla.org/rhino/">http://www.mozilla.org/rhino/</a>

再項目的目錄下建一個docs目錄，編輯Build.xml：

&lt;taskdef name="jsdoctoolkit" classname="uk.co.darrenhurley.ant.tasks.JsDocToolkit"classpath="${jsdoctoolkit.home}jsdoctoolkit-0.4.jar;${rhino.home}js.jar"/&gt;

&lt;jsdoctoolkit jsdochome="${jsdoctoolkit.home}" template="jsdoc" outputdir="./docs" encoding="utf-8"&gt;

如果有中文指定輸入/輸出檔案的編碼encoding="utf-8"

<a href="http://code.google.com/p/jsdoc-toolkit-ant-task/">jsdoctoolkit ant task的詳細屬性</a>

關于JSDoc的簡單用法：

由于生成的文檔頁面預設是UTF-8的，是以源檔案應該也是UTF-8編碼的。

基中一些最常用的标簽：

/**

* @fileoverview 對這個js檔案介紹一下

* @author Kejun 維護人的聯系方式

* @version 0.0.1 版本

*/

生成之後這段将出現在"File Index"裡。

定義類：

個人資訊類

@class

var myConfig = {

name: "Kejun",

title: "Web Developer",

顯示我的名字

@function say

say: function(){

alert("我叫" + this.name);

}

};

定義構造器：

* 一個人物的基類

* @constructor

function Person(name, title){

this.name = name;

this.title = title;

@namespace myApp包括我的一些應用

YAHOO.CN.myApp = {};

myConfig, Person, YAHOO.CN.myApp将會出現在“Classes”清單中。

另外常用的對Function的描述：

* 顯示某人的年齡

* @function

* @param {string} sName 名字

* @param {number | sring} nAge 年齡

屬性定義

我的名字

@type string

這些将出現在對應的Class/Namespace/Constructor或Global下面。

你還可以使用下面的方法安裝：

然後應用即可。前面的兩個路徑分别是我的Python和setuptools的安裝路徑，你需要修改成你自己的。

開始 》運作 》(Win + R)輸入“cmd”，輸入：

沒有任何輸出，即表示setuptools安裝成功。接着依次輸入運作：

儲存并運作test.bat後，就會發現D:\yui\src中多了parser和generator兩個目錄，而generator中正是你要的文檔。

把所有.js檔案都轉成不帶BOM的UTF-8編碼

修改檔案/bin/yuidoc_highlight.py：

在Python的\Lib\site-packages\下增加一個名為sitecustomize.py的檔案，其内容為：

謝謝小馬提供中文注釋的解決方案