1. 前言
「乾淨的程式碼」不是什麼神聖不可侵犯的東西,而是工程師活下去的工具。任何 OOP 專案,不管一開始多美,class、field、method、奇怪的關聯很快就會堆一堆……只要美感跟結構一亂,一週後你自己的 code 就會變成解不開的謎題。想看「求生之戰」可以去看 Robert Martin 的 《乾淨的程式碼》,就是在講這種戰鬥。
程式碼風格不是「看你爽」,而是讓大家都好過一點:
- 同事(或你自己)可以秒懂發生什麼事。
- 錯誤(尤其是架構錯)馬上就看得出來。
- 要改 code 也比較不會出包。
來看看怎麼讓 OOP 程式碼變成審查員、同事、甚至 linter 都會愛的樣子吧。
2. 命名:你的第一道防線
Class 命名
Class 在 C# 裡都用 PascalCase(每個單字開頭大寫,例如:MyNewClass),而且名字要能直接回答「這是什麼?」。名字一定要用名詞!
public class StudentAccount { /* ... */ }
public class InvoiceGenerator { /* ... */ }
爛範例:
class doMagic { ... } // 爛:什麼魔法?PascalCase 也沒用好。
Method 命名
Method 也是 PascalCase,但這裡最好用動詞 + 受詞:
public void PrintReport() { ... }
public string GetFormattedName() { ... }
Method 要能看出動作(Print、Get、Save、Calculate 等等),這樣讀起來才知道會發生什麼事。
Field 和 Property 命名
Field 通常是 private,用小寫開頭的 camelCase,常常會加底線:
private int _count;
private Student _owner;
Property 則是 PascalCase,因為是 class 的對外介面:
public int Balance { get; set; }
變數
區域變數 用 camelCase,越短越貼近語意越好:
string inputName;
int studentCount;
拜託,像 a1、result2、something 這種變數,只有你想下個月自己玩解謎遊戲才用。
3. Class 結構怎麼排
成員排好,瀏覽起來超順,馬上就能看懂邏輯。
通常順序:
- Constructor
- Property
- Method
- 巢狀型別(enum, class 等等)
範例:
public class Student
{
// --- 欄位 ---
private string _name;
// --- 建構子 ---
public Student(string name)
{
_name = name;
}
// --- 屬性 ---
public string Name
{
get => _name;
set => _name = value;
}
// --- 方法 ---
public void PrintInfo()
{
Console.WriteLine($"名字: {_name}");
}
}
這些「區塊」用註解分開(// --- 方法 ---)很方便,尤其 class 很大時。JetBrains Rider、Visual Studio 這些 IDE 都能快速摺疊/展開區塊。
4. 註解與文件
註解是好東西。但亂用或寫「解釋難懂 code」的註解就很糟,這時候應該直接改 code!
好註解 是解釋「為什麼」,不是「做什麼」。
// 用 Guid 當唯一識別碼,因為系統是分散式的
public Guid Id { get; set; }
Method、Class、Property 的文件
用 xml 文件註解 class 跟 public method。IDE 滑鼠移過去就會顯示說明。
/// <summary>
/// 代表大學生。
/// </summary>
public class Student
{
/// <summary>
/// 學生名字。
/// </summary>
public string Name { get; set; }
}
哪些不用註解
- 超簡單的東西(i++ // i 加 1)。
- 爛命名的變數(「// 這裡做點什麼」——嗯?做啥?)。
5. 分工合作才是王道
小 class、小 method
黃金法則:一個 class 一個責任(參考 單一職責原則)。如果 Student 這個 class 既管成績、又處理 email、還管課表——這就怪怪的。
- Class 300-400 行內都 OK。再多就該想想了。
- Method 15-20 行內最好。例外是那種超大 case 的 handler。
爆炸 method 範例:
public void Process()
{
// 通知客戶
// 存檔
// 寄 email
// 寫 log
// ...(15 步)
}
更好的寫法:
public void Process()
{
NotifyClient();
SaveChanges();
SendEmail();
LogActivity();
}
每個步驟都拆成 private method,code 變精簡也好測試。
6. 實用小技巧
視覺結構:排版、縮排、空行
IDE 都能自動排版(Visual Studio Ctrl+K, D,Rider Ctrl+Alt+L),但基本原則還是要懂。
- 縮排:4 個空白。不要用 tab,也不要 2 個空白。
- 空行:method 之間、field 跟 property、property 跟 method 都要空一行。
- 大括號 class 跟 method 都要新的一行(Allman 風格):
public class Test
{
public void Print()
{
Console.WriteLine("Hello");
}
}
「強」跟「弱」成員:access modifier
能封就封,只開放真的要給外部用的。只在 class 內用就 private,要給繼承用就 protected。public 只給對外合約。
爛範例:
public string ConnectionString; // 誰都能改!
更好:
private string _connectionString;
public string ConnectionString
{
get => _connectionString;
private set => _connectionString = value;
}
用自動屬性
有了自動屬性跟 init-only setter,手動寫 property 已經很不時髦了。
範例:
public string Name { get; set; } // 超棒!
public int Age { get; init; } // 只能初始化,更安全。
如果要計算型 property:
public string FullName => $"{FirstName} {LastName}";
封裝、getter/setter
如果 property 有商業邏輯要控管,用 private field + public getter/setter 加邏輯。
private int _grade;
public int Grade
{
get => _grade;
set
{
if (value < 0) _grade = 0;
else if (value > 100) _grade = 100;
else _grade = value;
}
}
這樣你或別人就不會不小心「搞壞」物件。
7. 更多小建議
別怕 interface 跟 abstraction
Interface 是為了好訂 contract、好測試、好擴充。
爛:
- interface 只有一個 method,結果根本沒人用;
- 只有一個 class 實作這個 interface。
- 有 2 個以上 class 用這個 interface;
- interface 拿來抽象外部系統(像 logging、data storage)。
寫 code 要能輕鬆測試
好 OOP code 的一個指標就是「好測試」。
- 不要寫 method 裡面全都用 global variable 或 static field。
- 不要怕 dependency injection——constructor 傳參數進來就好(Dependency Injection)。
- 把計算(邏輯)跟 user interaction(輸入/輸出)分開。這樣不只好測試,改 app 也輕鬆。
新手常見地雷跟小撇步
- 不要寫「上帝 class」(God Object),什麼都包。
- 不要用「魔法數字」沒解釋(if (status == 42)——為什麼 42?)。
- 不要為了繼承而繼承——有時候 composition(class 裡有別的 class 當 field)比繼承好。
- 不要寫 100 行的超長 method——根本沒人能測也看不懂。
- 永遠要留擴充空間(open/closed principle)。
8. 爛 code 跟好 code 長怎樣
爛範例:
class s // 爛:class 名字小寫。
{
public int a; // 沒意義,爛名字
public void m() // 爛:method 只有一個字母。
{
Console.WriteLine(a);
// 爛:完全看不懂這 method 幹嘛。
}
}
好範例:
// 代表學生。
public class Student
{
// 學生年齡。
private int _age;
public int Age
{
get => _age;
set => _age = value < 0 ? 0 : value;
}
// 輸出學生資訊。
public void PrintInfo()
{
Console.WriteLine($"學生年齡: {Age}");
}
}
GO TO FULL VERSION