javaWeb项目命名规范

一、项目结构

这里和其他项目区别不大,我将模板抽离出来,更容易分析和理解:

解释一下:js主要包括extends(引入第三方的js)、module(项目模块自己的js)、lib(引用包,这里也可以继续拆分),module中包含具体的模块中的js。common.js是核心命名空间的js.

二、common.js

解释一下,Globals作为全局命名空间,各个模块均可以在此命名空间里定义域(如果有不明白的可以自学下命名空间,这个文件写死就行,也不用具体理解)。

三、task.js

这个文件是模块中我的项目中任务模块的js(例子),模块级别的js一般是将页面中相对独立重要的方法抽离出来的方法,不建议所有页面js都拿进来。

解释一下:模块级别的js 主要包括自己的私有属性和方法,及对外暴露的js属性和方法。这里我们默认凡是内部私有的前面都加“_”,最后决定哪些方法和属性暴露出来,是通过构造方法constructor来对外暴露。

四、页面index.jsp

现在看一下jsp中如何对页面js和模块js是怎么引用的吧,见证解耦和的时候到了。

解释一下:页面需要将common.js与task.js引入,然后初始化,这样就可以访问task模块中对外暴露的方法和属性了。

页面js建议所有的变量发在一个变量组中,这样便于维护。

页面中控件的onclick等方法建议在js中统一绑定。

总结:通过上面的配置,最大的好处是对于项目中频繁引入js文件,消除了之间的耦合性,而且对于不同模块间的同名方法和属性也不会互相影响,当然最主要的便于持续的开发和维护,同时也是艺术上的享受。

本文采用了我习惯的注释风格,当然可以因人而异,我的原则是:

1.模块介绍代码主要关注:模块描述,负责人,相关备注,采用双星注释

/**

*

*/

2.对于模块下,大区域的划分,习惯采用双横线注释:

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

//描述:

3.对于区域中,方法注释,通过以往的经验,不是每个人都愿意详细去写的,所以我认为简单明了最好,采用普通注释:

//代码描述

//作者备注等信息(不限)

4.对于区域中一些重要的方法,或者想区分一下,划定小区间的,采用星横线

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

时间: 2024-10-25 10:40:25

javaWeb项目命名规范的相关文章

项目命名规范(二)

项目命名规范 1.文件夹命名 1).最好用一个单词描述 常用项目命名 omi.element.master.project.test.vue.iview 二级目录 build.static.config.src.examples.base.common.issues.assert 三级目录 libs.models.plugins.skins.images.css.js 2).如果一个单词描述不了,用2个词(名词加动词) color-pick.button-groups.date-picker.o

JavaWeb项目前端规范(采用命名空间使js深度解耦合)

没有规矩不成方圆,一个优秀的代码架构不仅易于开发和维护,而且是一门管理与执行的艺术. 这几年来经历了很多项目,对代码之间的强耦合及书写不规范,维护性差等问题深恶痛绝.在这里,通过仔细分析后,结合自己的编码习惯总结了一套适用于javaweb项目的前端书写规范,与大家分享一下. ps:感谢阿海的创意,后期整理如下(附文件下载): 一.项目结构 这里和其他项目区别不大,我将模板抽离出来,更容易分析和理解: 解释一下:js主要包括extends(引入第三方的js).module(项目模块自己的js).l

java项目命名规范

一.命名规范 1. 项目名全部小写 2. 包名全部小写 3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 如:public class MyFirstClass{} 4. 变量名.方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写. 如:int index=0; public void toString(){} 5. 常量名全部大写 如:public static final String GAME_COLOR="RED"; 6.所有命名规则必须

JavaWeb项目命名不规范带来的问题(作死的节奏啊)

这段时间在用三层做Web项目时,出现了一个很奇怪的问题,我在用户登录的servlet(Login)中通过session.setAttribute设置对象参数,理论上用户登录成功后参数传递成功,在其他servlet中便可通过session.getAttribute获取对象参数的值,但是怎么都是null值,测试了很多次都不行,搜了很多资料也没找到问题的所在.什么session过期时间,什么ttomcat配置文件的修改啊,什么重定向会导致session失效呀,就去查看tomcat的源码,看看是不是使用

Java项目命名规范(简洁版)——高薪必看

作为一个优秀的项目经理或项目带头人,必须养成良好优秀的项目命名规则和习惯.接下来把查到的资料整理一下,实际上,在很多项目中,也是遵循以下的规则. 一.项目名 全部小写,比如cms.workdesk,jobserver等 二.java相关命名 a.类命名:每音节单词前的第一个字母大写,比如FieldInfo.Expression等\ b.普通变量(包括spring里的变量引用命名):第一个单词前小写,以后每个单词第一个字母大写,password,primaryFlag c.静态变量:全部大写,多个

Java 项目命名规范

规范概览 对于一个标准的项目来说,目录名.包名.类名.方法名.变量名,这些名称都有一个大致的规范. 名称 规范 包名 公司域名倒写 数据访问层 dao.persist.mapping.mapper 实体类 entity.model.bean.javabean 业务逻辑 service.biz 控制器 controller.servlet.action.web 过滤器 filter 监听器 listener 异常 exception 类名和方法名的注释 /**     */ 方法内部的注释 /* 

项目命名规范

1 模块名称    比如计量模块写出JL 2注释 / *   */对方法进行注释或者对属性,有利于功能的扩展 3 包名 :每个包名都应该小写,例如:com.haiyisoft.store 4 类名 :TaskPlan 中间不允许出现下换线,并且首字母大写. 5  变量的命名 :writeSectno首字母小写并且符合命名驼峰命名法则 6  Static Final 变量的命名 变量的名字应该都大写,并且指出完整含义. 变量的各个单词之间用下划线分隔 Static final MAX_CONNEC

Maven项目命名规范

Guide to naming conventions on groupId, artifactId and versiongroupId will identify your project uniquely across all projects, so we need to enforce a naming schema. It has to follow the package name rules, what means that has to be at least as a dom

项目复习期总结3:CSS引入方式,注释,命名规范,背景,行高,文本属性

目录: 1.CSS注释的书写 怎么写?好处? 2.CSS引入方式  各种的优缺点 3.选择器的写法与选择器的优先级 4.CSS命名规范 5.背景,行高 6.文本(text与font开头)等所有属性 ① CSS注释书写规范: 1.单行注释:    直接写在属性值的后面,如: ① .search{ border:1pxsolid#fff;/*定义搜索输入框边框*/ background:url(../images/icon.gif)no-report#333;/*定义搜索框的背景*/ } ② .wr