JavaScript重构（八）：JSDoc和JSLint

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”