JSDoc可以生成類似於JavaDoc一樣的API文檔,這對於前端開發是必不可少的。
下載jsdoc-tookit(http://code.google.com/p/jsdoc-toolkit/)和jsdoc-tookit-ant-task(http://code.google.com/p/jsdoc-toolkit-ant-task/),CSDN的轉義功能有問題,所以把尖括號都換成瞭書名號:
其它也有類似的工具,DOC生成器對於任何一個成熟的前端開發團隊都是必不可少的。
Xml代碼
<project default="build-docs">
<target name="build-docs">
<property name="base" location="." />
<taskdef name="jsdoctoolkit" classname="uk.co.darrenhurley.ant.tasks.JsDocToolkit" classpath="jsdoc-toolkit-ant-task-1.1.0.jar;jsdoc-toolkit/java/classes/js.jar"/>
<jsdoctoolkit template="jsdoc" jsdochome="${base}/jsdoc-toolkit/" outputdir="${base}/output/">
<source file="portalone-common.js" />
</jsdoctoolkit>
</target>
</project>
JSLint是用來對JavaScript代碼做靜態檢查的工具(http://jslint.com/),不過這個應該不是開源的;而且需要ruby運行環境和gvim,再配合cscript engine,使用起來有諸多不便。項目中不可能總使用在線版本:
Eclipse上也開發瞭相應的JSLint plugin,另外,有一個很方便的工具jslint-toolkit(http://code.google.com/p/jslint-toolkit/):
先配置config.json,紅色字體就是要檢查的js目錄:
Js代碼
{
// JavaScript files to check
//"includes": ["scripts//source", "scripts//jquery"],
"includes": ["scripts//my"],
// Exclude files
"excludes": [],
// Exclude file names (Regex expression)
"excludeNames": ["//.svn", "CVS"],
// Output directory
"outPath": "out"
}
輸出結果一目瞭然:
作者“四火的BLOG”