java项目开发代码规范

项目开发代码规范

 

1 、编写目的

 本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。

本规范仅是初步设计，会在具体的项目开发过程中不断的修改及完善。

2、框架设计

ssh+layui

 

3、JAVA 程序编写规范

  命名关键字

登陆 Login

    注册 Register

    用户 User

    创建 Create

    修改 Update

增加 Add

    删除 Delete

    列表 List

查询 Find

    控制器 Controller

    用户名 Username

    密码 Password

 

 

3.1包命名

包命名采用全小写命名

通过唯一域名+组件来命名（如 ：com.xz.crm.action）

 

3.2类命名

大写字母开头，各个单词首字母大写(如：HelloWorld.class)

尽量使用英文单词来作为类的命名，勿以汉语拼音词的首字母来命名， 如不能以英文 命名，则须以汉语拼音的全拼来命名。 

Dao、Action、Service：  以相应的业务名称加后缀命名 如LoginAction、    LoginService

3.3方法命名

小写字母开头，各个单词首字母大写(如helloWorld())

属性的getter和setter方法尽量使用自动生成，并放在程序的后面。

 

3.4变量命名

小写字母开头，各个单词首字母大写

变量名字不宜过长，可适当采用缩减英文元音字母来缩短长度

 

 

3.5常量的命名规则 

全部使用大写的字母，每一单词用下划线隔开。 如：private final    int     TRACE_FILE_NAME=12345

 

3.6页面文件命名

采用全小写命名法

所有的字母均小写，单词之间以下划线’_’分隔

展示页面，按照名词+描述，如：news_list.jsp

操作页面，按照名词+动词命名，如：news_add.jsp

按照模块从大到小命名，如：news_order_add.jsp

3.7空格、换行、对齐

（1）所有{}里面的使用Tab键来缩进代码。

（2）{}花括号应该另起一行，左花括号与方法名、类名在同一行。(除了数组初始化时    的花括号)

 if、while等语句，假如体内只有一句代码也不要省略{}，为了方便以后的增删

 字符串过长考虑拆分成多行

（3）{}括号等应该对齐

 类和方法的块注释必须紧贴类和方法

 单独起行的//注释必须对齐被注释语句

 

3.8数据库及实体类

表名所有的字母均小写，单词之间以下划线’_’分隔

小写字母开头，各个单词首字母大写  如 crmName

 

3.9注释

团队成员都应该形成良好的写注释的习惯，方便以后阅读及后期维护。

(1)所有变量使用//做行注释

(2)实体类、表名、列名每个字段必须注释或描述

(3)方法  （注释模板）

    /** 
        * 描述:
        * 创建人：${user}
        * 创建时间：${date}${time}  
        * ${tags} 
        *${return_type}
        *@throws
 */

 

(4)类class（注释模板）

/**   

       * 项目名称：${project_name}   

       * 类名称：${type_name}   

       * 类描述：   

       * 创建人：${user}   

       * 创建时间：${date}${time}   

       * 修改人：${user}   

       * 修改时间：${date}${time}   

       * 修改备注：   

       *@version    

*    

*/

 参考 http://wenku.baidu.com/link?url=tb0gVWza21n9kZwHJPEggzCaoqx5ial7zo7phJH55iuDQRWu2V_3jy9TbdV5RnVw1dKZNoykvYwy_mZJalJ2e88M5vnGW9s9Enmkgarq0u7

 
http://blog.csdn.net/u011383131/article/details/51227860