Java代码规范那些事

开发 后端
Java开发中所要遵守的编码规范大体上有如下7点。命名规范、注释规范、缩进排版规范、文件名规范、声明规范、语句规范以及编程规范。

Java开发中所要遵守的编码规范大体上有如下7点。命名规范、注释规范、缩进排版规范、文件名规范、声明规范、语句规范以及编程规范。

1.命名规范

(1)所有的标示符都只能用ASCⅡ字母(A-Z或a-z)、数字(0-9)和下划线“_”。

(2)一个***包名的前缀总是全部小写的字母。例如:www.tonysun.cc

(3)类名是一个名词,采用大小写混合的方式,每个单词的首字母大写。例如:Tony。

(4)接口的大小写规则与类名相似:例如:Tony。

(5)方法名是一个动词或动词词组,采用大小写混合的方式,***个单词的首字母小写,其后单词的首字母大写。例如:setNeekeName(String neekeName)。

(6)变量名***个字母小写,任何中间单词的首字母大写。变量名应简短且可以顾名思义,易于记忆。例如:neekeName、neekeAddress。避免单个字符的变量名,除非是一次性的临时变量。

(7)常量的声明应该全部大写,每个单词之间用“_”连接。例如:final String WWW_TONY_CN = "www.tonysun.cc";

2.注释规范

(1)注释尽可能使用“//”;对于所有的javadoc的注释则使用“/** */”;而临时对代码块进行注释尽量使用“/* */”。

(2)所有的源文件都应该在开头有一个注释,其中列出文件名、日期和类的功能概述。

(3)每个方法必须添加文档注释(类的main()方法除外)。

(4)每个属性必须添加注释。

(5)代码中至少包含15%的注释。

(6)注释使用中文。

3.缩进排版规范

(1)避免一行的长度超过60个字符。

(2)使用Eclipse的源代码的格式化功能完成代码的缩进排版(Ctrl+Shift+F)。

4.文件名规范

(1)一个Java源文件只能存储一个Java类。

(2)文件名与Java类名相同。

(3)一个类文件的代码行不超过200行。

5.声明规范

(1)一行声明一个变量。

(2)不要将不同类型变量的声明放在同一行。

(3)只在代码块的开始处声明变量。

(4)所有的变量必须在声明时初始化。

(5)避免声明的局部变量覆盖上一级声明的变量。

(6)方法与方法之间以空行分隔。

6.语句规范

(1)每行至少包含一条简单语句。

(2)在return语句中,返回值不使用小括号“()”括起来。

(3)if语句总是用“{”和“}”括起来。

(4)在for语句的初始化或更新子句中,避免因使用三个以上变量,而导致复杂度提高。

(5)当switch的一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释。

7.编程规范

(1)提供对实例以及类变量的public或private访问控制,尽可能不适用默认值或protected访问控制。

(2)避免用一个对象访问一个类的静态变量或方法。应该用类名代替。

(3)避免在一个语句中给多个变量赋相同的值。

(4)用switch()语句实现多路分支。

(5)如果使用JDBC,则考虑使用java.sql.PreparedStatement,而不是java.sql.Statement。

(6)用于设置对象状态的方法前缀必须是set;用于检索一个布尔类型对象状态的方法前缀必须是is,而用于检索其他方法前缀必须是get。

(7)程序中应尽可能少使用数字(或字符),尽可能定义静态变量来说明该数字(或字符)的含义。程序中需要赋值或比较时,使用前面定义的静态变量。在循环控制中例外。

原文链接:http://tonysun3544.iteye.com/blog/1287903

【编辑推荐】

  1. Java效率真的很低吗?Android为何要采用?
  2. 漫谈Java开源5年:自由但带着枷锁
  3. BicaVM:基于JavaScript的JVM-为什么呢?
  4. Java漏洞成黑客目标 微软呼吁用户更新软件
  5. 分布式缓存Memcached的Java客户端优化历程
责任编辑:林师授 来源: TonySun3544的博客
相关推荐

2021-04-22 05:43:22

索引设计SET

2015-09-14 09:28:47

2015-08-13 10:54:46

2015-05-28 14:02:09

JavaJava日志性

2017-04-10 18:10:31

2015-08-20 09:17:36

Java线程池

2024-02-04 17:03:30

2017-05-15 21:50:54

Linux引号

2015-07-23 09:30:43

烂代码程序员

2021-03-07 16:31:35

Java编译反编译

2024-03-18 00:00:05

Java服务JVM

2011-05-19 16:47:50

软件测试

2012-05-01 08:06:49

手机

2012-01-02 19:30:22

iPad

2010-07-26 11:02:19

Perl模式匹配

2009-07-29 10:36:04

北电收购

2011-09-19 15:40:35

2011-07-04 15:30:24

Qt 布局 GridLayout

2020-07-29 08:14:59

云计算云迁移IT

2015-09-14 09:16:17

iOS统计打点
点赞
收藏

51CTO技术栈公众号