JAVA编程规范总结

JAVA编程规范总结：

1.编码规范好处：

1.减少维护成本和时间

2.增加可读性，方便自己和维护的技术人员二次改善

3.提高开发效率，团队协作

4.养成好习惯，提高自身修炼

2.命名规范：

1、尽量使用完整的英文描述符
3、采用大小写混合使名字
4、尽量少用缩写
5、避免使用长的名字（小于 15 个字母为正常选择）
6、避免使用类似的名字，或者仅仅是大小写不同的名字
7、避免使用下划线（除静态常量等）

Package命名

Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成，可以采用顶级域名 com、edu、gov、mil、net、org加上项目名加上功能名字

例如：com.net.ftp

类（ Class ）命名

类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。

接口（ Interface ）命名

和类定义一样，但是接口一般规范需要在前进加上大写I和类区别开来（实现接口一般和类一样，但是在末尾加上Impl）

枚举（ Enum ）的命名

和类定义一样，但是接口一般规范需要在前进加上大写E区别开来

方法（ Method ）的命名

方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写（驼峰形式）。方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头。

异常（ Exception ）的命名

异常（ Exception ）通常采用字母 e 表示异常，对于自定义的异常类，其后缀必须为 Exception

参数（ Param ）的命名

第一个单词的首字母小写，其后单词的首字母大写（驼峰形式）

常量字段（ Constants ）的命名

静态常量字段（ static final ）全部采用大写字母，单词之间用下划线分隔例如：功能名_返回值

3.注释规范（每个公司有每个公司规范，仅参考）

1.头部/** */ 写明版权信息以及该文件的创建时间和作者，修改内容修改时间等。

2.方法名需描述方法功能，参数属性，参数含义，返回值，及其它任何约束或前提条件。

3.逻辑注释，详细写明逻辑到底做什么，得到什么结果，返回什么等。给后期人员提供参考

4.块注释用/** */,单行注释用/* */和//。

5.为了后期维护能很好理解和生成接口文档，注释文档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。

6.javadoc注释标签语法
@author    对类的说明标明开发该类模块的作者
@version   对类的说明标明该类模块的版本
@see      对类、属性、方法的说明参考转向，也就是相关主题
@param    对方法的说明对方法中某参数的说明
@return    对方法的说明对方法返回值的说明
@exception  对方法的说明对方法可能抛出的异常进行说明

每层命名规范：

控制器Controller (动词+名称驼峰+Controller)

服务接口IService (I+动词+名称驼峰+Service)

服务层Service (动词+名称驼峰+ServiceImpl)

数据访问接口IDAO (I+动词+名称驼峰+Dao)

数据访层DAO (动词+名称驼峰+DaoImpl)

数据模块MODEL（大小写规范）

额外：

return endStatus; 最好只有一个return且在最后

//判断分开写，否则下一技术调试维护难下手，逻辑不清晰

if(isweiter)

{

if(isread)

{

………

}

connon连接需要配对出现，登陆不成功也要进行关闭

contorer 控制层一般调用简单，看不出服务层构造

server层一般是单例，处理简单判断

dao层处理逻辑，先定义接口，抽象类

总结不好多多担待，文章只单纯个人总结，如不好勿喷，技术有限，有错漏麻烦指正提出。本人QQ:373965070

JAVA编程规范总结相关推荐

java编程规范换行_Java编程规范整理
近期即将开始编码阶段,特地整理一下各方面的编程规范与命名约定,以便内部团队风格统一. 文章大多从网络上收集汇总而来,参考列表附在文章末尾. Java编程规范整理基本命名规范包命名包名按照域名的范 ...
java 标识变量_Java变量与数据类型之一：Java编程规范，关键字与标识符
原标题:Java变量与数据类型之一:Java编程规范,关键字与标识符大家好,这次要给大家带来的是Java变量与数据类型.本文是第一集:Java编程规范,关键字与标识符. 一.编程规范任何地方的名字 ...
java与数据类型相关的十个关键字_乐字节Java变量与数据类型之一：Java编程规范，关键字与标识符...
大家好,这次要给大家带来的是Java变量与数据类型.本文是第一集:Java编程规范,关键字与标识符. 一.编程规范任何地方的名字都需要见名知意: 代码适当缩进书写过程成对编程对代码进行合理注释 ...
阿里巴巴Java开发规范线程池_阿里巴巴java编程规范.pdf
阿里巴巴java编程规范目录一.编程规约1 (一) 命名规约1 (二) 常量定义3 (三) 格式规约4 (四) OOP 规约6 (五) 集合处理 10 (六) 并发处理 12 (七) 控制语句 1 ...
Java编程规范(一)
Java编程规范编程规约命名风格常量定义代码格式 OOP约束来源:阿里巴巴编程规约命名风格不能以下划线或者美元符号开始或结束 **反例**:_name / __name / $name ...
sun公司java编程规范【转载】
java编程规范要学习的大致内容有如下部分,一个目录: Java编码规范 1 1.说明 3 1.1为什么要有编码规范 3 1.2版权声明 3 2.文件名(File Names) 3 2.1文件后缀(F ...
html 注释_java基础- Java编程规范与注释
一前言 java编程规约是指在java代码编写过程中通俗的约定:通常我们是要遵守这些规范:这好比我们在生活中要遵守的道德准则,如果你做的事情超出了道德的底线,那就有可能会受到社会抨击:在java编程 ...
java编程规范每行代码窄字符,wiki/0xFE_编程规范.md at master · islibra/wiki · GitHub
0xFE_编程规范使用UTF-8编码使用空格缩进命名清晰表达意图, 少用缩写(行业通用除外, 如: request=req, response=resp, message=msg), 不应使用 ...
生成注释_java基础- Java编程规范与注释
一前言 java编程规约是指在java代码编写过程中通俗的约定:通常我们是要遵守这些规范:这好比我们在生活中要遵守的道德准则,如果你做的事情超出了道德的底线,那就有可能会受到社会抨击:在java编程 ...

JAVA编程规范总结

JAVA编程规范总结相关推荐

最新文章

热门文章