Java编码体例

2012/11/8 7:44:00  人气 722    怀旧国机论坛  
编程时应该注重自己的编程风格,增加必要的注释和空格.采用缩进格式,使程序中使用的算法框架简单清楚。除此之外,定义的各种标识符也要遵从惯例,注意大小写。最好能望名知意,望名知用途。这样,不论是自己编写程序、调试程序,还是对其他人阅渎程序,都会有帮助的。下面介绍Java中的一些命名约定。
(1)类 类名应为名词,含有大小写,每个字的首字母大写。类名如:l_telloWorld,Customer,MergeSort等。
(2)接口 接口是一种特殊的类,接口名的命名约定与类名相同。
(3)方法方法名应是动词,含有大小写,首字母小写,其余各字的首字母大写。尽量不要在方法名中使用下划线。方法名如:get.Name,setAddress,search。
(4)常量简单类型常量的名字应该全部为大写字母,字与字之间用下划线分隔,对象常量可使用混合大小写。常量名如:BLuE—COLOR.
(5)变量所有的实例、类和全局变量都使用混合大小写,首字符为小写。用大写字符作字间的分隔符。变量名中不要使用下划线。还要避免使用美元符号($$$$$$$$),因为该字符对内层类有特殊含义。变量名如:balance,orders等。
变量名应是有意义的。名字应向读者表明它的用意,做到望文知意。应避免使用单字符名字,除非是临时使用的要“扔掉”的变量(如循环变量k,它不在循环外使用)。
除了命名约定外,编码方面也应遵守某些约定。如程序流程方面,对if_else或for结构中的所有语句要用一对大括号括起来,哪怕只有一个语句也最好括起。每行只写一条语句,用4格或3格缩进对齐方式增加可读性。在必要的地方增加适量的空格。
要习惯用注释解释意义不明显的代码段。通常用“∥”注释定界符表示普通注释,而大段代码可用“/*…*/“形式注释。使用“/**……*/”文档注释可为将来的维护人员提供API。

发表回复

   


  通知楼主
暂无回复!