Java语言的编写规范

javaEye

命名的规范
•ackage 的命名
•应该都是由一个小写单词组成。
•Class 的命名
•必须由大写字母开头而其他字母都小写的单词组成
• Class 变量的命名
•变量的名字必须用一个小写字母开头。后面的单词用大写字母开头
•Static Final 变量的命名
•Static Final 变量的名字应该都大写，并且指出完整含义
•参数的命名
•参数的名字必须和变量的命名规范一致
•数组的命名
•数组应该总是用下面的方式来命名： byte[] buffer
•方法的参数
•使用有意义的参数命名
•如果可能的话，使用和要赋值的字段一样的名字
•代码编写格式
•代码样式
•代码应该注意回车换行的格式
•在一个项目中不要混用unix和windows 两种不同的回车换行格式
•文档化
•是用 javadoc 来为类生成文档
•它是标准，也被各种 java 编译器都认可的方法
•缩进
•缩进应该是每行2个空格
•不要在源文件中保存Tab字符.
•Tab字符会因为用户设置的不同而扩展为不同的宽度.
•页宽
•页宽应该设置为80字符
•超长的语句应该在一个逗号或者一个操作符后折行
•一条语句折行后, 应该比原来的语句再缩进2个字符

•{} 对
•{} 中的语句应该单独作为一行
•括号
•左括号和后一个字符之间不应该出现空格
•右括号和前一个字符之间也不应该出现空格
•不要在语句中使用无意义的括号

程序编写规范
•exit
•exit 除了在 main 中可以被调用外，其他的地方不应该调用
•后台服务地程序不应该因为某个库模块决定要退出就退出
•异常
•申明的错误应该抛出一个RuntimeException或者派生的异常
•垃圾收集
•需要调用close的对象一定要及时调用close
•打开的流对象
•数据库连接
•Clone
•final 类
•绝对不要因为性能的原因将类定义为 final
•一个类还没有准备好被继承，最好在类文档中注明
•访问类的成员变量
•大部分的类成员变量应该定义为 private 的来防止继承类使用他们