java开发代码规范之我见

来源:互联网 发布:验证码 源码 编辑:程序博客网 时间:2024/05/17 04:23
  最近开开发过程中发现命名方面不规范,代码写了也经常没有格式化导致增加了代码的可读难度。之前还以为自己代码有注释已经很给力了,  但是最近到了新的工作环境才发现如果能用英文准确的表达我这个方法的用途的话我压根就没必要注释....  、哈哈,下面是我最近工作的一些代码规范总结以及网上参考意见 Class 的命名 一般都是大写开头的,组成的每个单词首字母都大写,建议不要写超过四个单词变量 的命名的话采用驼峰命名法,第一个单词用小写 ,不过常量一般都是用全大写的,中间用下划线隔开。方法的参数尽量使用有意义的参数命名,可能的话使用跟要赋值的字段一样的方法名字,提高代码的可读性对字符串的判断统一采用commons的工具类StringUtiles 处理方法名的第一个单词应是动词,并且首字母小写,其它每个单词首字母大写 写完代码尽量采用idea 的格式化快捷键格式化 jsp页面的那些对象也采用驼峰命名法 类的布尔类型的判断方法一般采用is开头命名,或者采用同样有判读意义的单词构造方法应该用递增的方式写(比如:参数多的写在后面)。例如: public CounterSet(){} public CounterSet(int size){ this.size = size;} 同个文件可以有多个类,但是只能有一个public 的类,并且名称跟该类一样每个类开头一般注明该类是谁写的,日期,该类的功能java的包名一般都是采用小写的 一般采用域名的反写然后代码打log 的时候一般把关键信息打出来就可以了,如查询的id啊,关键字啊,避免一些无意义的log不要频繁的对代码进行注释,这样会显得代码质量很低,一般在一些关键的地方注释就可以了空行将逻辑相关的代码段分隔开,以提高可读性。下列情况应该总是使用两个空行:一个源文件的两个片段(section)之间类声明和接口声明之间下列情况应该总是使用一个空行:两个方法之间     方法内的局部变量和方法的第一条语句之间块注释或单行注释之前 注意:空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。如果没有足够的理由,不要把实例或类变量声明为公有。一般都是采用set,get引用类变量和类方法 避免用一个对象访问一个类的静态变量和方法

一些代码命名方面的规范也可以参考这个:http://zz563143188.iteye.com/blog/1833834

1 0