jGrouseDoc 簡單介紹與安裝

簡單介紹

jGrouseDoc 是一套撰寫 JavaScript 說明文件的產生器, 是以 JAVA 為基礎撰寫.

優點

因為 jGrouseDoc 產生說明文件的方式, 是以 js 裡面的註解, 自動產出HTML, 很方便, 又免費.

安裝

使用需要三個東西
jGrouseDoc + JRE + ApacheAnt

或是到
jGrouseDoc => http://code.google.com/p/jgrousedoc/downloads/list

JRE => http://www.oracle.com/technetwork/java/javase/downloads/index.html

ApacheAnt => http://ant.apache.org/bindownload.cgi

下載 jGrouseDoc 之後, 將它解壓縮, 它是你之後要產生 說明文件的 地方,  ( 例如: E:\xampp\htdocs\jGrouseDoc )

安裝JRE 到預設路徑 或 指定路徑. ( 例如: C:\Program Files\Java\jdk1.7.0_09 )

下載 ApacheAnt 之後, 將它解壓縮. ( 例如: E:\xampp\htdocs\apache-ant-1.8.4 )

設定( 共兩種方式 for window )
方式一: 到DOS環境下

window 用戶可以 開始 >> 執行 >> cmd.exe 輸入>>




C:\User\LeoYeh>set ANT_HOME=E:\xampp\htdocs\apache-ant-1.8.4
C:\User\LeoYeh>set JAVA_HOME=C:\Program Files\Java\jdk1.7.0_09

C:\User\LeoYeh>set PATH=%ANT_HOME%\bin;%JAVA_HOME%\bin

方式二: 透過WINDOW設定

控制台 >> 系統及安全性 >> 系統 >> 環境設定 >> 進階 >> 環境變數 >> 系統變數

在DOS環境下輸出

C:\>ant -version
Apache Ant<TM> version 1.8.4 compiled on May 22 2012

這樣表示安裝成功


執行
最後需要在DOS底下產生 說明文件

到 jGrouseDoc 所在的目路底下 輸入 ant -f build.xml, 

例如: E:\xampp\htdocs\jGrouseDoc>ant -f build.xml

最後你會看到
BUILD SUCCESSFUL
Total time: 1 second

這樣HTML說明文件就產出了

Enjoy !