快速改善代码质量的20 条编程规范

命名

大到项目名，模块名，包名，对外暴露的接口，笑道类名，函数名，变量名，参数名。只要做开发，我们就逃不过起名字这一关，命名的好坏，对于代码的可读性来说非常中国要。 甚至起到决定性的作用。除此之外，命名能力也体现了一个程序员的而基本的素养。这也是我们把命名放到第一位的原因。 

取一个合适的名字是一个非常有挑战的事情，即便是堆母语是英语的程序员来说，也是如此。对于我们这些英语非母语的程序元来说，要起一个准确达意的名字更是难上加难。 

实际上，命名不能拿，关键还是看你重视不重视。 愿意不愿意花时间 比如包名，接口名，类名，我们一定要反复斟酌，实在想不到好的名字，可以去Github上i想的关键词联想搜索以下，看看这些类似的代码时怎么命名的。 

例子： 

public calss User{

  private Stirng userName;

}

userName,这个user 这样一个前缀，可以从上下文中推断。所以直接命名为name 

除此之外，函数名也可以借助上下文来简化命名。 

public void uploadUserAvatarimageToAliyun(Stirng userAvatarimageUri) 

public void uploadUserAvatarimageToAliyun(Stirng imageuri) 

命名一定要有可读性。 这样才能方便交流。 

接口命名的时候前边加I， 类实现的时候，后边加Impl 。抽象类，直接叫名字。 

一个好的命名完全可以代替注解。 如果需要注解，那么需要在命名上下功夫。 个人觉得这样的观点太过于极端。 命名再好有长度限制，不能够相近，而这个时候，注解时一个很好的补充 。 

注解到底写什么

注解的目的时为了让代码更容易看懂，只要符合这个要求的呢容，就可以讲它写道注解里。 总结一下注解的内容主要包含三个方面： 做什么，为什么这么做，怎么做。