俗话说:“不以规矩不成方圆”。万事万物都有自己的一套规范,越轨就得被削。废话也不多说了,今天小牛就说说Java的编程规范吧。
通用规则:
一、保持原有的风格
一般情况下,我们程序员都是拿了别人的代码来修改的,我们就不应该试图在修改代码中引入一种新的风格,更不要试图重写旧的代码以迎合新的风格,这样是不对地。有的瓜娃子还粗暴的改写,令人叹为观止。
二、坚持最小惊奇的原则
避免可能让用户感到意外的做法,或许你的初衷是好的,最好不要。
三、一次做对
有好多同学都喜欢写代码的时候,先按照自己的习惯方式写,再根据给定的要求重新排版。
四、记录所有非规范的行为
没有任何标准可以放之四海而皆准,有时你会不得已而偏离标准体系,那么请你记录在文档中。
格式规范:
五、缩进嵌套的代码,增强可读性
六、断开长句
比如:
double x=Math.random(); double y= Math.random();--太长啦
改为:
double x=Math.random();
double y=Math.random();-->避免编辑器的横向滚动
七、使用空白
用空白把方法、注释、代码块和表达式表示清楚,多么的行云流水,让人一种享受的感觉。一边敲着代码一边唱着“今天我很快乐”,那是何等的舒服啊。
八、不要直接使用Tab
不同的环境对Tab的解释可能不同,可能导致格式混乱。
命名规范:
九、名称应有实际意义
为类、变量、方法或常量命名时,应使用能有效说明所命名实体用途的词汇来命名,避免使用单个字母或通用名。
十、使用人们熟悉的名称:
尊重目标行业的通用术语,如用户习惯用“Customer”,那你就不要使用“Client”。
十一、保留元音字母
如message缩写为msg。
十二、审视使用过长的名称
如果类、接口或方法的名字过长,可能说明这个实体的定义过于庞杂。那么你的重新审视一下他的设计,看看是否合理。
十三、缩写词的第一个字母大写
loadXMLDocument() -->loadXmlDocument()
setDSTOffset() -->setDstOffset()
十四、不要使用只依赖大小写来区分的名字
如:theSQLInputStream <--> theSqlInputStream
Java编译器是可以区分这些大小写不同的名字,但人在阅读的时候很可能注意不到这些细微的差别。
好了,小牛这次的编程规范就这么多了,有朋友路过补充的话,小牛会非常高兴,非常感谢!