使您的JavaScript可维护

时间:2009-01-29 16:16:48

标签: javascript jquery

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

7 个答案:

答案 0 :(得分:9)

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

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

构建脚本应该:

  • Lint您的所有代码
  • 剥离评论
  • 将文件连接在一起
  • Minify / Obfuscate / Compress the code
  • 用于部署的版本文件
  • 将版本文件推送到服务器,准备在生产中“打开”

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

答案 1 :(得分:8)

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

答案 2 :(得分:8)

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

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

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

答案 3 :(得分:6)

创建一个在构建过程中运行的脚本,该脚本将从javascript中删除所有注释。

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

答案 4 :(得分:4)

我建议尽可能多地将javascript代码放入外部脚本文件中,以增加一些模块性。但除此之外,评论和保持代码和标记尽可能干净是任何编程项目中最好的,无论语言如何。

答案 5 :(得分:3)

另外,如果可以的话,尽量做一些面向对象的设计。我曾经参与过一个涉及大量jQuery / Javascript的项目,它没有面向对象的设计,这让我们很难开发和维护它一段时间。随着时间的推移,我们实际上最终重写了部分内容以使其更好。

因此,我最好的建议是提前思考,评论(就像其他人所说的那样),并确保您编写Javascript代码的方式与编写其他内容相同(例如,遵循所有优秀的设计原则) d使用服务器端语言。)

答案 6 :(得分:3)