java命名命名规范java命名规范
一、命名规范(所有的标识符都只能用ASCII字母(A-Z或a-z)、数字(0-9)和下划线“_”,注意命名要有意义(就是可以顾名思义,易于记忆))
1.包的命名:一个唯一包名的前缀总是全部小写的字母。
2.普通类的命名:类名是一个名词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母要大写。
3.接口的命名:接口的命名与类名相似。
4.常量的命名:常量的声明应该全部用大写,每个单词之间用“_”连接。
5.方法的命名:方法名是一个动词或动词词组,采用大小写混合方式,第一个单词首字母小写,其后单词的首字母大写。
6.变量的命名:变量名第一个字母小写,任何中间单词的首字母大写。变量名应简短且可以顾名思义,易于记忆。
二、注释规范
1.注释尽可能使用“//”;对于所有的javadoc的注释则使用“/** */”;而临时对代码块进行的注释尽量用“/* */”。
2.所有的源文件都应该在开头有一个注释,其中列出文件名、日期和类的功能概述。
3.每个方法必须添加文档注释(类的main()方法除外)。
4.每个属性必须添加注释。
5.代码中至少包含15%。
6.注释使用中文。
三、缩进排版规范
1.避免一行的长度超过60个字符。
2.使用Eclipse的源代码的格式化功能完成代码的缩进排版(快捷键Ctrl+Shift+F)。
四、文件名规范
1.一个Java源文件只能存储一个Java类。
2.文件名与Java类名相同。
3.一个类文件的代码行不超过200行。
五、声明规范
1.一行声明一个变量。
2.不要将不同类型变量的声明放在同一行。
3.只在代码块的开始出声明变量。
4.所有的变量必须在声明时初始化。
5.避免声明的局部变量覆盖上一级声明的变量。
6.方法与方法之间以空行分割。
六、语句规范
1.每行至多包含一条简单语句。
2.在return语句中,返回值不使用小括号“()”括起来。
3.if语句总是用“{”和“}”括起来。
4.在for语句的初始化或更新子句中,避免因使用三个以上变量,而导致复杂度提高。
5.当switch的一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释。
七、编程规范
1.提供对示例以及类变量的public或private访问控制,尽可能不使用默认值或protected访问控制。
2.避免用一个对象访问一个类的静态变量和方法。应该用类名代替。
3.避免在一个语句中给多个变量赋相同的值。
4.用switch()语句实现多路分支。
5.如果使用JDBC则,考虑使用java.sql.PreparedStatement,而不是java.sql.Statement。
6.用于设置对象状态的方法前缀必须是set;用于检索一个布尔类型对象状态的方法前缀必须是is,而用于检索其他类型对象状态的方法前缀必须是get。
7.程序中尽可能少用数字(或字符),尽可能定义静态变量来说明该数字(或字符)的含义。程序中需要赋值或比较时,使用前面定义的静态变量。在循环控制中例外。例如我们学的
常量。
八、规范代码样例
暂无
九、项目框架结构
暂无
java编程命名规范小结
猜你喜欢
转载自20120923lina.iteye.com/blog/1692031
今日推荐
周排行