代码整洁之道
写代码一定要规范操作吗?
网上很多相关的讨论与回答。在此,举个例子说明吧:
有次我被临时借调到另一个项目组,去帮忙赶一个需求。写代码的时候我犯了一个最蠢的错误,就是按自己的配置对代码做了格式化。全部写完并提交代码后的那天中午我去医院了。
下午接了那个项目组组长一个电话,问我提交的代码做了哪些改动。我报了几个路径,并告诉了他我的修改标记。
第二天到公司后,组长告诉我因为我的代码格式与组内规范不一样,导致合并测试版本的时候,几乎每行都有差异。版本管理员不得不一行一行对比、询问该使用哪个版本、然后再合并、提交测试。
这次提交不到十个文件,目测实际改动的代码行数不超过 100 行,但是害的版本管理员从下午两点多一直干到六点多才合并完版本。这还是在我每一处修改都有修改标记的情况下花费的时间。
我想这个例子能够说明不遵守规范的问题,和遵守规范的好处了吧!
在 code 看来,coder 就是神,我们可以任性,但是我们一定要遵守一定的规范。做人做事,我们可以有创新,可以与别人不一样,但是写代码就要规范。
很多小伙伴也是找我要一些 代码规范 的相关资料,于是我翻箱倒柜,找到了这本讲述了一系列行之有效整洁代码操作实践的电子书——《代码整洁之道》。
资料介绍
全书一共 17 章内容!覆盖面广、知识面全、案例丰富!简直太优秀了!
让我印象最深的还是第四章,专门介绍注释的一个章节,因为和实际工作简直太贴合了。
作者举例了好多坏注释的类型:
喃喃自语:注释没有实际的意义,就好像是程序员自说自话;
……
如何获取?
识别二维码并关注公众号「Java 后端技术全栈」;
在公众号后台回复关键字「303」。
评论