代码整洁之道

写代码必定要规范操做吗?

网上不少相关的讨论与回答。在此,举个例子说明吧:程序员

有次我被临时借调到另外一个项目组,去帮忙赶一个需求。写代码的时候我犯了一个最蠢的错误,就是按本身的配置对代码作了格式化。所有写完并提交代码后的那天中午我去医院了。后端

下午接了那个项目组组长一个电话,问我提交的代码作了哪些改动。我报了几个路径,并告诉了他个人修改标记。ide

次日到公司后,组长告诉我由于个人代码格式与组内规范不同,致使合并测试版本的时候,几乎每行都有差别。版本管理员不得不一行一行对比、询问该使用哪一个版本、而后再合并、提交测试。测试

此次提交不到十个文件,目测实际改动的代码行数不超过100行,可是害的版本管理员从下午两点多一直干到六点多才合并完版本。这仍是在我每一处修改都有修改标记的状况下花费的时间。日志

我想这个例子可以说明不遵照规范的问题,和遵照规范的好处了吧!代码规范

在code看来,coder就是神,咱们能够任性,可是咱们必定要遵照必定的规范。作人作事,咱们能够有创新,能够与别人不同,可是写代码就要规范。code

不少小伙伴也是找我要一些 代码规范 的相关资料,因而我翻箱倒柜,找到了这本讲述了一系列行之有效整洁代码操做实践的电子书——《代码整洁之道》。blog

资料介绍it

全书一共17章内容!覆盖面广、知识面全、案例丰富!简直太优秀了!class

让我印象最深的仍是第四章,专门介绍注释的一个章节,由于和实际工做简直太贴合了。

做者举例了好多坏注释的类型:

喃喃自语:注释没有实际的意义,就好像是程序员自说自话;

多余注释:注释没有做用,并且读注释比读代码还累;

误导性注释:注释不够精准,反而误导了读者;

循规式注释:满口胡言,让人迷惑;

日志式注释:冗长的注释!这种状况真的是常常出现呀!

……

代码整洁之道

如何获取?

识别二维码并关注公众号「Java后端技术全栈」;

在公众号后台回复关键字「303」。

相关文章
相关标签/搜索