如何做到JAVA代码规范?

优秀的JAVA代码编写规范应该遵守:

1、  类、关键的方法要有文字说明。JAVA语言允许三种方法:

(1)、文档的注释格式:/**             */

(2)C风格的注释格式:/*           */

(3)、单行的注释格式:    //

2、  类、接口、属性、方法、常量的名称不应该太长,也不可以短,能具体表达意思即可。

(1)、类名称规范是名称的第一个字母大写,如果多个单词组成类的名称,那么每个单词的第一个字母大写。

(2)、接口名称的规范是名称的第一字母大写,如果多个单词组成接口的名称,那么每个单词的第一个字母大写,采用描述性的名字描述接口。

(3)属性的名称的规范是第一个单词的所有字母小写,其余单词的第一个字母大写,可以在名称前面使用字母标识属性的变量类型,也可以在名称前面或者后面使用符号“_”标识属性。

(4)、方法名称的规范是第一个单词的所有字母小写,其余单词的第一个字母大写,设置内部变量的方法使用关键字get开头,返回布尔值的方法使用关键字is,has,can等开头。

(5)、常量名称的规范是所有字母大写,单词与单词之间使用分隔符“_”。

3、  代码的摆放要有层次感,不同层次的代码应低两格摆放。

注:优秀的编码规范必须遵守少于30秒原则,一段优秀的代码只需30秒便可以让人弄明白这段代码的目的与功能。

posted on 2004-09-23 17:40  软件下载园  阅读(1249)  评论(0)    收藏  举报

导航