javaweb项目前端规范(使用命名空间使JS深解耦)

如果没有规则而不是成方圆,优秀的代码架构不仅易于开发和维护,而且是一种管理和执行的艺术。

在过去的几年中,许多项目都曾经历过的,和强耦合的代码和维护之间的写作问题是不一致的。在这里,经过仔细分析,我们总结出了一套前端写Javaweb项目用自己的编码习惯与你分享规格。

PS:谢谢你Ahai的想法,整理如下(附文件下载):

1。项目结构

这与其他项目没有什么不同。我画出模板,更容易分析和理解。




解释:JS主要包括延伸(引入第三方JS),模块(项目模块的JS),库(也可分开这里参考包),模块包含在特定的modules.common.js是js js。核心命名空间的

二,common.js



解释变量为全局命名空间,该命名空间中的每个模块可以定义域。如果你不理解它,你可以自己学习名称空间,这个文件是死的,它也不需要被理解。

三、task.js

这个文件是模块中任务模块的js模块。模块级js通常是分离页面中相对独立的重要方法的一种方式。不建议将所有页面JS带入。



解释:模块级JS有自己私有的属性和方法,以及JS的属性和方法,接触到外面的世界。我们都在默认的内部和_面前,最后决定哪些方法和属性暴露,构造函数外暴露的施工方法。

四、页面index.jsp

现在看看页面JS和模块JS在JSP中是如何引用的,当见证者被解耦时,就到了该走的时候了。







解释:网页需要引入common.js和task.js,然后初始化,这样的方法和属性的任务模块暴露可以访问。

Page JS建议将所有变量发送到一组变量,这样就很容易维护。

在页面控件的onclick等方法表明,结合统一的JS。

总结:通过以上的配置,最大的优势是在项目的js文件频繁出台,消除耦合关系,但也不是名字不同模块之间的方法和属性的相互作用,当然最重要的可持续发展和维护,又是艺术的享受。

本文使用我的自定义注释样式,当然,它可以因人而异。我的原则是:

1。模块介绍了代码的主要焦点:模块描述、负责人、相关说明和双星注释。



*

* /

2。对于模块下大区域的划分,习惯上使用双行注释。

/ / ==================================================

描述:

3、对于区域、方法注释,通过过去的经验,并不是每个人都想详细地写,所以我认为它简单明了。

代码描述

/作者说明和其他信息(不限于)

4。对于区域内的一些重要方法,或区分区间,使用星交叉

****************************描述***************************** / /

如果有好的想法我们可以讨论,如果写作的感觉不是什么来帮助自己,当笑的权利。