浅谈编程风格---编码规范

浅谈编程风格---编码规范

      对于程序员来说，没有谁可以说没有犯过类似的错误。其实，编码规范对于所有做程序的人来讲，都是一种好习惯的体现。这就好比自己家里的卫生非常整洁，而且摆放有序，分类明确，一旦想找某些东西时，可以快速定位。我们程序中也是一样，良好的编码习惯有助于程序的调试，因为谁也不敢保证自己写的程序跑起来没有问题，如果真的是写完了测试不出一点问题，反倒是让人挺担心的。这个笔者是深有体会。

       还是讲讲我们的编程风格吧：

 

       1.Package ：Package 的名字应该都是由一个单词（公认的单词缩写）或尽量简洁的英文词组构成，例如：com.bank.wms

。包名的全文都应小写。

 

        2.类、接口命名

类的名字必须由大写字母开头而其他字母都小写的单词组成，缩写词必须全部大写。

例如：DataFile或DepartmentKPI。

      根据Java类的不同功能，需要在其后加上不同的后缀以示区分，例如：

      1.     工具函数类的后缀为*Util

      2.     Action层的后缀为*Action

      3.     业务层的后缀为*Manager

      4.     实体Bean由于用以描述业务对象，因此不加后缀。

      5.     如果在业务逻辑层进行了接口约定，则应在接口的实现类后加缀Impl。例如：UserManagerImpl。

 

      3.变量、参数命名

       变量、参数的名字必须用一个小写字母开头。后面的单词用大写字母开头。

例如：debug 或 inputFileSize。

对象实例变量尽量与对象的类名保持一致，但首字母改为小写。

例如：DynaBean dynaBean。

当同一代码块内出现多个同类型实例变量的时候，应该在变量后加缀描述此变量在当前代码块内所起到的作用。

例如：DynaBean dynaBeanDic;  String dicCodeForPage; 等等

 

      注意：(1).Static Final 变量的名字应该都大写，单词之间通过下划线“_”分隔，并且指出完整含义，例如：MAX_UPLOAD_FILE_SIZE=1024。

         (2).数组变量的数组标识符必须紧跟变量的类型标识，其它部分均应参照变量的命名规范

 

 

       4.实例方法名：

      对于实例方法的命名统一遵循首单词小写字母开头，后面的单词大写字母开头的原则。

     在普通JavaBean中，属性访问方法遵守POJO原则，即：

     访问前缀+首字母大写的属性名称

     访问前缀分为set,get,is三种。

     用于设置对象状态的方法规定必须在首字母大写的属性名称前面加一个前缀set；用于检索一个布尔类型对象状态的方法必须在前面加一个前缀is；而用于检索其它类型对象状态的方法则必须在前面加上get。

 

   

      5.文件注释：

       大部分注释尽量在行上用"//"；对于所有的javadoc的注释则用"/**  */"；而临时对代码块进行的注释尽量用"/*  */"。如果类中需要对private方法进行注释，应该在方法上采用”/*  */”的方式。

要求

1.   程序中注释行应不低于程序代码行的20%；

2.   类、方法、业务相关变量必须注释说明；

3.   注释内容应根据客户要求的语言进行，原则上，除常量、变量、变量类型等以外的说明尽可能采用中文注释；

 

 

       以上只是浅谈了一下编程的风格，还有很多如：jsp中import包的规范、if-else中的大括号、代码的缩进距离、SQL语句关键字的大小写问题等等，每个公司都有自己某些独特的风格。但是，其中一些比较传统的风格我们一定要坚持去做，比如说注释，只有这样才能养成好的习惯，也有利于我们后期程序的调试。