JavaScript重构(八):JSDoc和JSLint

本文介绍了JSDoc作为JavaDoc替代方案在前端开发中的应用,以及JSLint作为静态代码检查工具的重要性。通过配置Ant任务实现自动化文档生成,并详细解释了如何使用JSLint及其相关工具提高代码质量。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

JSDoc可以生成类似于JavaDoc一样的API文档,这对于前端开发是必不可少的。

image

下载jsdoc-tookit(http://code.google.com/p/jsdoc-toolkit/)和jsdoc-tookit-ant-task(http://code.google.com/p/jsdoc-toolkit-ant-task/),优快云的转义功能有问题,所以把尖括号都换成了书名号:

《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="p-common.js" /》
        《/jsdoctoolkit》
    《/target》
《/project》

其它也有类似的工具,DOC生成器对于任何一个成熟的前端开发团队都是必不可少的。

 

JSLint是用来对JavaScript代码做静态检查的工具(http://jslint.com/),不过这个应该不是开源的;而且需要ruby运行环境和gvim,再配合cscript engine,使用起来有诸多不便。项目中不可能总使用在线版本:

image

Eclipse上也开发了相应的JSLint plugin,另外,有一个很方便的工具jslint-toolkit(http://code.google.com/p/jslint-toolkit/):

先配置config.json,红色字体就是要检查的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"
}

输出结果一目了然:

image

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值