使您的JavaScript可维护

我正在将内部应用程序转换为通过jQuery使用更多Ajax.我正在摆脱当前ASP.NET应用程序背后的标准代码,并结合将运行客户端的JavaScript方法.我担心的是,允许这个应用程序保持可维护状态的最佳方法是什么.

我发现构建脚本是可维护Javascript成功的关键.基本上,为了在最终页面上快速简洁地运行,您需要一个脚本来使其在开发中可维护.

如果使用构建过程,则可以根据功能将JS分解为文件.您可以在开发期间使用库的调试版本,并在您的代码周围留下光彩照人的代码注释而不受惩罚.

构建脚本应该:

提示你所有的代码

剥离评论

将文件连接在一起

缩小 /混淆/压缩代码

用于部署的版本文件

将版本文件推送到服务器,准备在生产中"打开"

这使您可以处理具有逻辑意义的文件,并在您进行生产后对其进行整理.

我会说,将相同类型的OOP原则应用于您应用于服务器端代码的javascript是增强可维护性的最佳方法之一.考虑创建封装javascript方法和数据的类,而不是全局函数.使用javascript单元测试框架来测试此代码,以确保它是健壮的.

运行JSLint作为构建的一部分,并确保如果它没有通过,它将使您的构建失败.

确保您的JS有效并不是可维护性的关键,但它会充实一些可能会被其他方式吱吱作响的浏览器问题.

如果可能,使用Rhinounit,JSUnit或QUnit等框架开始编写单元测试.

创建一个在构建期间运行的脚本,该脚本将从javascript中删除所有注释.

然后自由地发表评论,并鼓励其他人也安全地知道评论不会使其投入生产.