编码规范
文章平均质量分 90
秋哥Java实验室
Java实验室坚持输出Java基础教程,Spring系列干货文章,欢迎微信搜索【Java实验室】关注我的公众号,你想要的Java知识文章都有。
展开
-
Java 老司机总结的代码风格指南(下)
前言 之前我们讲了代码风格中函数、类多大才合适,一行代码多长最合适和善用空行分割单元块,今天我们继续讲解代码风格。 1. 四格缩进还是两格缩进? “PHP 是世界上最好的编程语言?代码换行应该四格缩进还是两格缩进?” 这应该是程序员争论得最多的两个话题了。据我所知,Java 语言倾向于两格缩进,PHP 语言倾向于四格缩进。至于到底应该是两格缩进还是四格缩进,我觉得这个取决于个人喜好。只要项目内部能够统一就行了。 当然,还有一个选择的标准,那就是跟业内推荐的风格统一、跟著名开源项目统一。当我们需要拷贝原创 2021-05-10 16:33:26 · 311 阅读 · 1 评论 -
Java 老司机总结的代码风格指南(上)
前言 之前我们讲了命名和注释,今天我们来讲一下代码风格(Code Style)。说起代码风格,我们其实很难说哪种风格更好。最重要的,也是最需要我们做到的,是在团队、项目中保持风格统一,让代码像同一个人写出来的,整齐划一。这样能减少阅读干扰,提高代码的可读性。 1. 类、函数多大才合适? 总体上来讲,类或函数的代码行数不能太多,但也不能太少。类或函数的代码行数太多,一个类上千行,一个函数几百行,逻辑过于繁杂,阅读代码的时候,很容易就会看了后面忘了前面。相反,类或函数的代码行数太少,在代码总量相同的情况下原创 2021-05-10 16:30:51 · 324 阅读 · 0 评论 -
会写注释才是合格的程序员
前言 上一篇中我们讲了命名,今天我们来讲一下注释(Comments)。注释其实就是针对复杂逻辑代码的解释和说明,解释为什么要这么写,这段代码大概功能是什么。注释的作用是方便阅读代码的人快速理解编写代码的人的思考。 注释 命名很重要,注释跟命名同等重要。很多书籍认为,好的命名完全可以替代注释。如果需要注释,那说明命名不够好,需要在命名上下功夫,而不是添加注释。实际上,我个人觉得,这样的观点有点太过极端。命名再好,毕竟有长度限制,不可能足够详尽,而这个时候,注释就是一个很好的补充。 1. 注释到底该写什原创 2021-05-10 16:28:55 · 230 阅读 · 0 评论 -
分享 Java 开发可参考的一份命名规范!
前言 设计原则和设计模式,利用好它们可以有效地改善代码质量。但是,这些知识的合理应用非常依赖个人经验,用不好有时候会适得其反。 而我们接下来要讲的编码规范正好相反。编码规范大部分都简单明了,在代码细节方面,能立竿见影地改善质量。除此之外,持续低层次、小规模重构依赖的基本上都是编码规范,这也是改善代码可读性的有效手段。 关于编码规范、如何编写可读代码,很多书籍已经讲得很好了。不过,这里我根据我自己的开发经验,总结罗列了 20 条我个人觉得最好用的编码规范。掌握这 20 条编码规范,能你最快速地改善代码质原创 2021-05-10 16:03:23 · 175 阅读 · 1 评论