空白與縮進:可讀性核心
- 單詞間隔:至少一個空格,數量不限
- 代碼縮進:包含關係(類、方法、塊)必須縮進,編譯器忽略行首空格
- 標準風格:每層 4 空格或 1 Tab,統一團隊規範
public class Demo {
public static void main(String[] args) {
int n = 10; // 縮進一層
if (n > 0) { // 縮進二層
System.out.println(n);
}
}
}
語句結束符 (;) 規則
- 每句必須以 ; 結束
- 一行可寫多句:
int a=1; int b=2;(不推薦)
- 長語句可換行:
System.out.println(
"Hello" +
world);
- 大括號/小括號結束處通常不加 ;
三大註釋類型對比
| 類型 | 語法 | 用途 | 可跨行 |
| 單行註釋 | // 內容 | 簡短說明:變量用途、邏輯標註 | 否 |
| 多行註釋 | /* 內容 */ | 複雜邏輯、算法原理、代碼段暫時禁用 | 是 |
| 文檔註釋 | /** 內容 */ | 類/方法/屬性 API 文檔,可被 javadoc 提取 | 是 |
註釋最佳實踐
- 比例建議:代碼 10%-20% 為註釋(每 100 行 10-20 行)
- 同步維護:修改代碼必須同步更新註釋,避免誤導
- 文檔註釋標籤:
@param、@return、@throws 等結構化標記
- 避免無效註釋:
i++; // i加1 ❌ 應註釋業務意圖而非語法
實戰範例
/** 計算圓面積
* @param radius 半徑
* @return 面積值
* @throws IllegalArgumentException 半徑為負
*/
public double circleArea(double radius) {
if (radius < 0) throw new IllegalArgumentException("半徑不能為負");
return Math.PI * radius * radius; // 核心公式
}