Java代码规范(一)

最近在看《代码整洁之道》(clean code)这本书,书里从各个方面讲述了作者对代码规范的一些理解。本人读完部分之后,对提到的一些规范有了一些自己的理解,以下是本人根据书上内容整理的一些规则。

首先是命名规范,遵循以下几点:

  1. 起一个名副其实且不会有歧义的词
  2. 不要用代表意义其实是一样的词来命名。比如我们给一个学生类命名,那么Student和Students其实是一样的,选定一个之后就不要再用另一个给其他的类命名了。
  3. 不要使用类型来给变量名(这点本人不怎么赞同)。这里的类型指的是如List、String这样的Java类型,但这一点我个人并不是很赞同,我认为写上之后可以更便于阅读,就比如一个变量命名为xxxList,可以更容易让人理解这个是一个什么变量,当然这是我自己最近开发的感受,如果读者有其他的看法欢迎讨论~
  4. 每一个概念对应一个词,可以使用计算机科学的专业术语来起名,如果无法使用计算机科学的属于也可以用所涉及问题的领域的术语来命名

其他的一些规则还有类名和变量名用名词或名词短语;函数名用动词或动词短语。另外,可以使用类名和模块名(文件夹名)给我们的变量添加语境。


接着是函数的规范,对函数来说大概要遵循的就是以下几点:

  1. 函数名应该是动词或动词短语(描述性的名字)。函数应该尽量能够让人一眼就看出该函数是干嘛的,当然这点自认为还有很长的一段路去探索才能做到。
  2. 函数应该越短越好,并且一个函数只做一件事(只包含一个抽象层级,错误处理也是一件事)。一个函数如果在中间暗中穿插做了了其他的事,很可能会导致一些未知的错误,比如本来是一个判断的函数却在其中一个情况里做了其他的操作,这就会导致一些问题了。但是函数如果做的只是一个抽象层级的事,也只算为一件事。
  3. 参数越少越好。函数最好是没有参数,这是最理想的情况,但一般情况下总是一个参数的情况居多。当有两个参数的时候函数已经回让人有点疑惑了,当然如果是像坐标点一样的有顺序且这个顺序是普遍认可的则可以接受;而超过三个参数的时候就应该考虑将函数拆分或者看看这几个参数是否都属于某个事物的部分,这样可以将几个参数封装进一个类,并把类作为参数进行传递。
  4. 分离判断与操作。不要把判断语句和赋值等混在一个方法里写,这样方法名会让人搞不清楚导致方法的作用不明确,从而误导使用者。
  5. 使用异常代替返回错误码。这一点是说错误码就违反了函数只做一件事的规则,而且异常可以提取出来一个单独的方法,不过错误码就违反了函数只做一件事的规则这一点总感觉有点问题,可能之后看多了会懂,如果有小伙伴知道的也可以解释一下~

 

剩下的章节等下次看完在更...

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值