文章目录一. 命名二. 关于注释三. 代码风格超实用的改善代码质量的编程规范一. 命名关于命名命名的关键是能准确达意。作用域小的变量比如临时变量可以适当地选择短一些的命名方式。我们可以借助类的信息来简化属性、函数的命名利用函数的信息来简化函数参数的命名。命名要可读、可搜索。不要使用生僻的、不好读的英文单词来命名。除此之外命名要符合项目的统一规范不要用些反直觉的命名。在 User 类这样一个上下文中我们没有在成员变量的命名中重复添加“user”这样一个前缀单词而是直接命名为 name、password、avatarUrl。在使用这些属性时候我们能借助对象这样一个上下文表意也足够明确。具体代码如下所示UserusernewUser();user.getName();// 借助user对象这个上下文//除了类之外函数参数也可以借助函数这个上下文来简化命名。publicvoiduploadUserAvatarImageToAliyun(StringuserAvatarImageUri);//利用上下文简化为publicvoiduploadUserAvatarImageToAliyun(StringimageUri);二. 关于注释关于注释注释的目的就是让代码更容易看懂。只要符合这个要求的内容你就可以将它写到注释里。总结一下注释的内容主要包含这样三个方面做什么、为什么、怎么做。对于一些复杂的类和接口我们可能还需要写明“如何用”。类和函数一定要写注释而且要写得尽可能全面、详细而函数内部的注释要相对少一些一般都是靠好的命名、提炼函数、解释性变量、总结性注释来提高代码可读性。三. 代码风格函数、类多大才合适函数的代码行数不要超过一屏幕的大小比如 50 行。类的大小限制比较难确定。一行代码多长最合适最好不要超过 IDE 显示的宽度。当然限制也不能太小太小会导致很多稍微长点的语句被折成两行也会影响到代码的整洁不利于阅读。善用空行分割单元块对于比较长的函数为了让逻辑更加清晰可以使用空行来分割各个代码块。在类内部成员变量与函数之间、静态成员变量与普通成员变量之间、函数之间甚至成员变量之间都可以通过添加空行的方式让不同模块的代码之间的界限更加明确。四格缩进还是两格缩进我个人比较推荐使用两格缩进这样可以节省空间特别是在代码嵌套层次比较深的情况下。除此之外值得强调的是不管是用两格缩进还是四格缩进一定不要用tab 键缩进。大括号是否要另起一行我个人还是比较推荐将大括号放到跟上一条语句同一行的风格这样可以节省代码行数。但是将大括号另起一行也有它的优势那就是左右括号可以垂直对齐哪些代码属于哪一个代码块更加一目了然。类中成员的排列顺序在 Google Java 编程规范中依赖类按照字母序从小到大排列。类中先写成员变量后写函数。成员变量之间或函数之间先写静态成员变量或函数后写普通变量或函数并且按照作用域大小依次排列。这里讲到所有的代码风格都没有对错和优劣之分只要能在团队、项目中统一即可不过最好能跟业内推荐的风格、开源项目的代码风格相一致。参考王争-《设计模式之美》
