使javascript可维护

使javascript可维护,javascript,jquery,Javascript,Jquery,我正在通过jQuery将内部应用程序转换为使用更多Ajax。我将不再使用当前ASP.NET应用程序背后的标准代码,而是加入将在客户端运行的JavaScript方法。我关心的是,对于我后面的人来说,让这个应用程序保持可维护性的最佳方法是什么 我建议将尽可能多的javascript代码放入外部脚本文件中,以添加一些模块化。但除此之外,注释和保持代码和标记尽可能干净是在任何编程项目中都能做到的最好的事情,无论使用何种语言。创建一个在构建过程中运行的脚本,从javascript中删除所有注释 然后自由地

我正在通过jQuery将内部应用程序转换为使用更多Ajax。我将不再使用当前ASP.NET应用程序背后的标准代码,而是加入将在客户端运行的JavaScript方法。我关心的是,对于我后面的人来说,让这个应用程序保持可维护性的最佳方法是什么

我建议将尽可能多的javascript代码放入外部脚本文件中,以添加一些模块化。但除此之外,注释和保持代码和标记尽可能干净是在任何编程项目中都能做到的最好的事情,无论使用何种语言。

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


然后自由地发表评论,并鼓励其他人也这样做,因为他们知道评论不会进入生产环境。

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

如果可以的话,还可以尝试进行一些面向对象的设计。我曾经参与过一个涉及很多jQuery/Javascript的项目,但它没有面向对象的设计,这使得我们很难开发和维护它一段时间。随着时间的推移,我们实际上最终改写了其中的一部分,使之变得更好

因此,我最好的建议是提前思考、评论(正如其他人所说),并确保您的Javascript代码与其他代码的编写方式相同(如中所述,遵循服务器端语言上使用的所有良好设计原则)。

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

确保你的JS是有效的并不是可维护性的关键,但它会使一些浏览器问题变得更加具体,否则这些问题可能会被忽略


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

!视频

我发现构建脚本是可维护Javascript成功的关键。基本上,为了在最后一页上有一些快速和简洁的内容,您需要一个脚本,使其在开发中可维护

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

构建脚本应:

  • 你所有的代码
  • 条状评论
  • 将文件连接在一起
  • /混淆/压缩代码
  • 用于部署的版本文件
  • 将版本文件推送到服务器,准备在生产中“打开”

这样,您就可以处理合乎逻辑的文件,并在生产后进行整理。

这对于开发和测试来说是个好主意,但您可能希望在生产中使用组合/最小化文件,以减少请求数量和响应大小。我认为这是一个很好的建议,只是有更完整的答案我投了赞成票。感谢提供示例框架,非常有用的JS Lint还提供了缺失的通知;这可能会在调试过程中造成可怕的生产问题,尤其是如果你缩小代码的话。回答太棒了,总结起来很好。谢谢:)我实际上正在计划下周的一个关于构建脚本的播客,所以我想到了:)@Downvoter,你可以说链接断了。不管怎样,我现在贴了一个工作链接,我最近写了这个