Java Coding Conventions

Java Coding Conventions

说明：编程不难，难的是写出好的程序来，良好的编码习惯有很多好处。写代码一定要精炼，要简单易懂。不少人以为自己写的代码很复杂，就觉得自己很了不起，事实恰恰相反。

类

很多对类的理解不够深刻，所以不清楚什么东西应该放在一个类里，什么应该放在另外一个类里，有的甚至把所有方法都放在一个类里，导致一个类或者一个方法写了几百上千行，当然这样做并不影响程序的执行，虽然类的数量对程序的执行没有太大的影响，但是对于调试程序和代码维护就有很大的影响。设计一个类时，站在各个角度考虑。 类尽可能短小精悍，而且只解决一个特定的问题。避免庞大的类出现。

命名

为了代码更容易理解，最简单的方法之一就是给你的类，方法，属性描述性很强的名字，避免使用奇怪名字，它们的命名，首先要遵从Java的命名规范，再遵从项目的命名规范。类的名字应该使用名词，方法第一个单词一般是动词。动词，名词，大小写，下划线等的使用都是有其道理和意义的。

注释

阅读代码的时间比写代码的时间多得多。思路清晰的设计可获得易于理解的程序，但注释、细致的解释以及一些示例往往具有不可估量的价值。尽可能细致地加上注释。这样其他的人员读到这段代码时就会很清 楚的知道这个方法的功能是什么，减少读代码的时间。

1. 在程序的分支处加注释
2. 在复杂的逻辑处加注释
3. 特殊处理处写详细的注释
4. 在已有的类中增加方法或修改方法，如果这个类不是自己创建的，建议加上作者，时间，注释。尽量不要修改别人一些逻辑复杂或重要的代码。
5. 在接口上写注释
6. 公用方法的注释，参数的说明和返回值的说明要写详细。

方法

方法的参数不要过多，如果参数过多，使用对象包装（比如Map）。但注释要写详细。原因是参数太多都不知道根本不知道其他参数都做什么，有需要调用这个方法，传个参数到这个方法中，所以只有新加一个参数，造成这个方法的参数越来越多，这种情况下，需要使用参数包。

判断

避免太复杂的判断逻辑，比如有多个and、or的情况，加括号分类，分行。

常量

尽量避免在方法体内出现写死的数字、字符串等。可以使用常量来表示。并对这个常量注释。增加可读性。

格式化

良好的代码格式化能让让赏心悦目，而不是一看就不想再看第二眼。一般使用eclipse的自动格式化。另外避免一行代码被格式化成多行。

无用代码

删除无用代码,写出来的每一行代码必定是有用的,有理由的。一段不需要的过时代码或者被注释掉的代码尽量不要保留在程序里，否则使代码越来越多，可读性越来越差。

代码顺序

良好的代码顺序也能让有效增加可读性。一个类，由上到下是有顺序的。