優秀的代碼勝過冗長的文檔。
1. 文件編碼
源文件編碼格式為UTF-8。
2. 包名使用小寫字母
3. import不要使用通配符
即,不要出現類似這樣的import語句:import java.util.*;
4. 列長限制
一個項目可以選擇一行80個字符或100個字符的列限制,超出列長限制時換行,換行時縮進至少4個空格,縮進不要用tab。
5. 注釋
注釋應少而精,代碼的關鍵處應該有注釋, 注釋不能誤導讀者。
6. 變量聲明
每次只聲明一個變量,不要使用組合聲明,比如int a, b;
需要變量時才聲明,並盡快進行初始化。
7. 命名約定
命名應該:見名知意、簡潔,避免拼音與英文混用。
命名風格:
類名以UpperCamelCase風格編寫
非常量字段名、方法名、參數名、局部變量名以lowerCamelCase風格編寫
常量名以CONSTANT_CASE風格編寫
8. 類成員順序
每個類應該以某種邏輯去排序它的成員,維護者應該要能解釋這種排序邏輯。比如,新的方法不能總是習慣性地添加到類的結尾。
9. 慎用System.out.println()
使用log而不是System.out.println()
10. 使用大括號(即使是可選的)
大括號與if, else, for, do, while語句一起使用,即使只有一條語句(或是空),也應該把大括號寫上。
11. 減少代碼嵌套
代碼嵌套層次達3層以上時,一般人理解起來都會困難。
減少嵌套的方法有很多:(1)合並條件;(2)利用return以省略後面的else;(3)使用子方法
12. 異常處理
捕獲的異常不能忽視,典型的響應方式是打印日志