本文件旨在提供一個全面的 C# 程式碼撰寫指南，以便開發團隊能夠編寫出一致且易於維護的程式碼。遵循這些準則將有助於提高程式碼的品質，並確保整個專案的協作效率。
-
縮排：使用空格進行縮排，每個縮排層級為 4 個空格。
這表示每一層的程式碼區塊都應該向右縮進 4 個空格，以增加程式碼的可讀性。
-
字元編碼：所有檔案應使用 UTF-8-BOM 字元編碼。
這能確保所有檔案 (包含程式碼、文字檔、設定檔等) 都能正確顯示各種字元，特別是中文等非 ASCII 字元。另外，含有「中文命名」的專案，這條規範尤其重要。
-
檔案結尾換行：檔案結尾不需要插入新的一行。
這是一種常見的程式碼規範，避免在檔案末尾出現多餘的空行。
-
using指示詞應根據以下規則排序：-
系統命名空間 (例如
System.*) 應排在前面。這能幫助開發者快速識別程式碼使用的系統相關資源。
-
不同的
using指示詞群組應以空白行分隔。透過分組和空白行區隔，可以更清晰地了解程式碼的依賴關係。
-
-
using指示詞應放在命名空間之外。這確保了
using指示詞的作用範圍涵蓋整個檔案，並且符合常見的程式碼風格。 -
using宣告應使用簡化的using語句形式 (例如using var foo = ...;)。這種簡化的語法能使程式碼更簡潔，並減少程式碼的冗餘。
-
命名空間應使用檔案範圍的命名空間宣告 (file-scoped namespace) (例如
namespace MyNamespace;)。這種宣告方式更簡潔，並且能更清楚地表明命名空間的作用範圍。
-
命名空間名稱應與資料夾結構一致。
這能讓程式碼結構更清晰，並方便維護和管理專案。
-
應使用 C# 語言關鍵字來表示內建型別 (例如，應使用
int而不是System.Int32)。使用關鍵字能使程式碼更簡潔，並符合 C# 的慣例。
-
在本地變數、參數和成員中使用預先定義的型別關鍵字。
這能確保程式碼的一致性，並減少開發者在閱讀程式碼時的認知負擔。
-
在成員存取中使用預先定義的型別關鍵字。
同樣是為了確保程式碼風格一致，並減少不必要的冗餘。
-
在程式碼中，不應使用
this.來存取事件、欄位、方法和屬性成員，除非有明確的語法衝突。這能使程式碼更簡潔，並減少程式碼的噪音。
-
在算術二元運算子、其他二元運算子和關係二元運算子中，應總是使用括號以增加程式碼清晰度。
括號能明確表達運算子的優先順序，避免程式碼出現意料之外的行為。
-
在其他運算子中，只有在必要時才使用括號。
避免不必要的括號可以使程式碼更簡潔。
-
對於非介面成員，應總是指定存取修飾詞 (
public、private、protected)。明確指定存取修飾詞能確保程式碼的可維護性，並避免出現不必要的安全隱患。
-
建議使用以下修飾詞順序：
public,private,protected,internal,file,const,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async。統一的修飾詞順序可以使程式碼更一致，並方便閱讀。
-
應使用
??空合併運算子 (Coalesce expression)。使用空合併運算子能使程式碼更簡潔，並避免處理空值時出現錯誤。
-
應使用集合初始器 (Collection initializer)。
使用集合初始器能使程式碼更簡潔，並方便初始化集合。
-
應使用明確的元組名稱 (Explicit tuple names)。
為元組明確指定名稱能使程式碼更易讀，並方便理解元組的含義。
-
應使用空值傳播運算子 (Null propagation operator,
?.)。使用空值傳播運算子能簡化空值檢查，並避免出現空值錯誤。
-
應使用物件初始化器 (Object initializer)。
使用物件初始化器能使程式碼更簡潔，並方便初始化物件。
-
當換行時，運算子應放在行首。
這能讓程式碼更易讀，並清楚表達運算符的優先順序。
-
應優先使用自動屬性 (Auto property)。
自動屬性能減少程式碼的冗餘，並使程式碼更簡潔。
-
當型別鬆散匹配時，應使用集合表達式 (Collection expression)。
集合表達式能更簡潔地初始化集合，並適用於不同型別之間的轉換。
-
應使用複合賦值運算子 (例如
+=，-=)。複合賦值運算子能使程式碼更簡潔，並減少程式碼的冗餘。
-
在條件賦值和返回時，應使用條件表達式 (
?:) 而非if/else語句。條件表達式能更簡潔地表達條件邏輯，並使程式碼更易讀。
-
在
foreach迴圈中，當有明確的型別宣告時，應優先使用明確的型別轉換。這能確保程式碼的型別安全，並減少運行時錯誤。
-
應推斷匿名型別成員名稱和元組名稱。
自動推斷名稱能使程式碼更簡潔，並減少程式碼的冗餘。
-
應優先使用
is null檢查，而不是使用== null或!= null的方式。使用
is null能更簡潔地檢查空值，並符合 C# 的語法慣例。 -
應使用簡化的布林表達式 (Boolean expression)。
在格式化 .NET 程式碼時，偏好簡化的布林表達式。這意味著在可能的情況下，編輯器會建議將複雜的布林邏輯簡化。例如，將
if (x == true)簡化為if (x)。這樣可以使程式碼更加簡潔和易讀，同時也避免了不必要的比較運算，並提高程式碼的執行效率。 -
應使用簡化的插值字串 (Interpolated string)。
在格式化 .NET 程式碼時，偏好簡化的插值字串。插值字串是指在字串中嵌入變數或表達式的值。例如，將
$"{x.ToString()}"簡化為$"{x}"。這樣可以使程式碼更加簡潔，並減少不必要的呼叫，同時也能提升程式碼的可讀性。
-
如果可能，應將欄位宣告為
readonly。如果欄位的值在初始化之後不會被修改，則應宣告為
readonly，以確保程式碼的安全性，並防止程式碼意外修改欄位的值。
-
應檢查是否使用未使用的參數。
如果參數在方法中沒有被使用，則應該移除該參數，以避免程式碼的混亂，並增加程式碼的可讀性。
-
不應在其他地方使用
var關鍵字。var關鍵字只能用於區域變數宣告，以避免程式碼的混亂。 -
不應針對內建型別使用
var。針對內建型別 (如
int,string,bool等)，應明確指定型別，以提高程式碼的可讀性。 -
在型別明顯可推斷時可以使用
var。只有在型別可以明顯從等號右邊推斷出來時，才可以使用
var，以避免程式碼的可讀性降低。
-
應使用表達式主體來定義存取子 (accessors)。
對於簡單的存取子 (如
get和set)，應使用表達式主體，以使程式碼更簡潔。 -
不應使用表達式主體來定義建構子、局部函式、方法和運算子。
對於複雜的建構子、局部函式、方法和運算子，應使用區塊語法，以增加程式碼的可讀性。
-
應使用表達式主體來定義索引子和 lambda。
對於簡單的索引子和 lambda，應使用表達式主體，以使程式碼更簡潔。
-
應使用表達式主體來定義屬性。
對於簡單的屬性，應使用表達式主體，以使程式碼更簡潔。
-
應優先使用模式比對而非使用
as運算子並進行空值檢查。模式比對能更簡潔地檢查型別和空值，並減少程式碼的冗餘。
-
應優先使用模式比對而非使用
is運算子並進行型別轉換檢查。模式比對能更簡潔地檢查型別和進行型別轉換，並減少程式碼的冗餘。
-
應優先使用擴展屬性模式。
擴展屬性模式能更簡潔地存取嵌套屬性，並減少程式碼的冗餘。
-
應優先使用
not模式。not模式能更簡潔地表達條件否定，並增加程式碼的可讀性。 -
應優先使用模式比對。
在可以使用模式比對的地方，應盡量使用模式比對，以增加程式碼的可讀性。
-
應優先使用 switch 表達式。
當需要使用
switch語句時，應優先使用switch表達式，以增加程式碼的簡潔性。
-
應使用條件委派呼叫 (
?.Invoke)。條件委派呼叫能更簡潔地檢查委派是否為空，並避免出現空值錯誤。
-
匿名函式應宣告為
static。如果匿名函式不需要訪問外部變數，則應宣告為
static，以提高程式碼的性能。 -
局部函式應宣告為
static。如果局部函式不需要訪問外部變數，則應宣告為
static，以提高程式碼的性能。 -
結構體應宣告為
readonly。如果結構體的值在初始化之後不會被修改，則應宣告為
readonly，以確保程式碼的安全性，並防止程式碼意外修改結構體的值。 -
結構體成員應宣告為
readonly。如果結構體的成員的值在初始化之後不會被修改，則應宣告為
readonly，以確保程式碼的安全性，並防止程式碼意外修改結構體成員的值。 -
應使用大括號 (
{})。在所有控制流程語句 (如
if、for、while等) 中都應使用大括號，以提高程式碼的可讀性。 -
應使用簡單的
using語句。對於只需要釋放資源的
using語句，應使用簡單的using語句，以減少程式碼的冗餘。 -
應優先使用主要建構子 (Primary Constructor)。
如果類別或結構體只有主要的建構子，則應使用主要建構子，以減少程式碼的冗餘。
-
應優先使用最上層語句 (Top-level statements)。
如果程式碼只包含簡單的程式碼邏輯，則應使用最上層語句，以減少程式碼的冗餘。
-
應優先使用簡單的 default 表達式。
當需要使用
default值時，應使用簡單的default表達式，以增加程式碼的可讀性。 -
應使用解構的變數宣告。
在需要使用元組或其他可解構型別時，應使用解構的變數宣告，以增加程式碼的可讀性。
-
當型別明顯時，應使用隱式物件建立 (Implicit object creation)。
當型別可以明顯從等號右邊推斷出來時，應使用隱式物件建立，以增加程式碼的簡潔性。
-
應使用內聯變數宣告 (Inlined variable declaration)。
如果變數只在一個地方被使用，則應使用內聯變數宣告，以減少程式碼的冗餘。
-
應優先使用索引運算子。
當需要使用索引存取集合時，應優先使用索引運算子，以增加程式碼的可讀性。
-
應優先使用局部函式而非匿名函式。
如果需要使用函式，且函式不需要訪問外部變數，則應優先使用局部函式，以提高程式碼的性能。
-
應優先使用空值檢查而非型別檢查。
在需要檢查物件是否為空時，應優先使用空值檢查，以避免出現不必要的型別錯誤。
-
應優先使用範圍運算子。
當需要使用範圍時，應優先使用範圍運算子，以增加程式碼的可讀性。
-
應優先使用元組交換。
當需要交換兩個變數的值時，應優先使用元組交換，以增加程式碼的簡潔性。
-
應優先使用 UTF-8 字串文字。
當需要使用 UTF-8 字串文字時，應使用 UTF-8 字串文字，以確保程式碼的字元編碼正確。
-
應使用
throw表達式。當需要
throw例外時，應使用throw表達式，以增加程式碼的簡潔性。 -
應使用棄置字元 (discard,
_) 變數來忽略未使用的賦值。當程式碼中有未使用的變數賦值時，應使用棄置字元 (
_) 忽略，以避免程式碼的警告。 -
應使用棄置字元 (
_) 來忽略表達式語句中未使用的值。當程式碼中有表達式語句，但其值不需要使用時，應使用棄置字元 (
_) 忽略，以避免程式碼的警告。
-
catch前應有換行。在
try...catch語句中，catch關鍵字之前應有一個新行，以增加程式碼的可讀性。 -
else前應有換行。在
if...else語句中，else關鍵字之前應有一個新行，以增加程式碼的可讀性。 -
finally前應有換行。在
try...finally語句中，finally關鍵字之前應有一個新行，以增加程式碼的可讀性。 -
匿名型別中的成員前應有換行。
在匿名型別中，成員之間應有新行，以增加程式碼的可讀性。
-
物件初始化器中的成員前應有換行。
在物件初始化器中，成員之間應有新行，以增加程式碼的可讀性。
-
在左大括號
{之前，應有換行。在所有程式碼區塊的左大括號之前，應有一個新行，以增加程式碼的可讀性。
-
查詢表達式子句之間應有換行。
在查詢表達式中，各個子句之間應有新行，以增加程式碼的可讀性。
-
區塊內容應縮排。
所有程式碼區塊的內容都應該向右縮排，以增加程式碼的可讀性。
-
大括號
{}不應縮排。程式碼區塊的左大括號和右大括號，應與對應的程式碼關鍵字對齊，而不是縮排，以增加程式碼的可讀性。
-
case內容應縮排。在
switch語句中，case關鍵字之後的內容應向右縮排，以增加程式碼的可讀性。 -
當
case內容使用區塊{}時，應縮排。當
case關鍵字之後的內容使用大括號包圍時，應將內容向右縮排，以增加程式碼的可讀性。 -
label應比目前縮排少一層。label標籤應該比目前的程式碼區塊縮排少一層，以增加程式碼的可讀性。 -
switch標籤應縮排。在
switch語句中，case和default標籤都應該縮排，以增加程式碼的可讀性。
-
轉換 (
cast) 後不應有空格。型別轉換運算子和變數之間不應有空格。
-
繼承子句中的冒號
:後應有空格。在類別繼承或介面實作中，冒號之後應有一個空格。
-
逗號
,後應有空格。在變數宣告、方法參數和集合初始化器中，逗號之後應有一個空格。
-
點號
.前後不應有空格。在物件成員存取時，點號前後都不應有空格。
-
控制流程語句中的關鍵字後應有空格。
在
if、for、while等控制流程語句中，關鍵字之後應有一個空格。 -
for語句中的分號;後應有空格。在
for迴圈中，分號之後應有一個空格。 -
二元運算子前後應有空格。
在二元運算子 (如
+、-、*、/等) 前後都應有一個空格。 -
宣告語句周圍不應有空格。
在變數宣告語句前後不應有額外空格。
-
繼承子句中的冒號
:前應有空格。在類別繼承或介面實作中，冒號之前應有一個空格。
-
逗號
,前不應有空格。在變數宣告、方法參數和集合初始化器中，逗號之前不應有空格。
-
開啟方括號
[前不應有空格。在集合或索引器存取中，開啟方括號之前不應有空格。
-
for語句中的分號;前不應有空格。在
for迴圈中，分號之前不應有空格。 -
空方括號
[]之間不應有空格。在宣告空陣列或空索引時，空方括號之間不應有空格。
-
方法呼叫的空參數列表括號之間不應有空格。
在方法呼叫時，如果參數列表為空，則括號之間不應有空格。
-
方法呼叫的名稱與左括號之間不應有空格。
在方法呼叫時，方法名稱和左括號之間不應有空格。
-
方法呼叫的參數列表括號之間不應有空格。
在方法呼叫時，如果參數列表不為空，則參數列表的括號之間不應有空格。
-
方法宣告的空參數列表括號之間不應有空格。
在方法宣告時，如果參數列表為空，則括號之間不應有空格。
-
方法宣告的名稱與左括號之間不應有空格。
在方法宣告時，方法名稱和左括號之間不應有空格。
-
方法宣告的參數列表括號之間不應有空格。
在方法宣告時，如果參數列表不為空，則參數列表的括號之間不應有空格。
-
括號之間不應有空格。
在括號內不應有額外空格。
-
方括號之間不應有空格。
在方括號內不應有額外空格。
-
應保留單行程式碼區塊。
在格式化 C# 程式碼時，應該保留單行的區塊。區塊通常是指用大括號
{}包圍的程式碼片段，例如if語句或方法定義。如果這個區塊的內容可以放在同一行，編輯器將會保留這種單行格式，而不會自動將其展開成多行。例如，if (x) { return true; }會被保留在一行內。 -
應保留單行程式碼語句。
在格式化 C# 程式碼時，應該保留單行的語句。這意味著如果某個語句可以放在一行內，編輯器將會保留這種單行格式，而不會自動將其拆分成多行。例如，
int x = 10;會被保留在一行內。
- 型別和命名空間 (Type and Namespace) 應使用 PascalCase (例如
MyClass,MyNamespace)。 - 介面 (Interface) 應使用 IPascalCase (例如
IMyInterface)。 - 型別參數 (Type Parameter) 應使用 TPascalCase (例如
TMyType)。 - 方法 (Method) 應使用 PascalCase (例如
MyMethod())。 - 屬性 (Property) 應使用 PascalCase (例如
MyProperty)。 - 事件 (Event) 應使用 PascalCase (例如
MyEvent)。 - 本地變數 (Local Variable) 應使用 camelCase (例如
myVariable)。 - 本地常數 (Local Constant) 應使用 camelCase (例如
myConstant)。 - 參數 (Parameter) 應使用 camelCase (例如
myParameter)。 - 公開欄位 (Public Field) 應使用 PascalCase (例如
MyField)。 - 私有欄位 (Private Field) 應使用 _camelCase (例如
_myField)。 - 私有靜態欄位 (Private Static Field) 應使用 s_camelCase (例如
s_myStaticField)。 - 公開常數欄位 (Public Constant Field) 應使用 PascalCase (例如
MyConstant)。 - 私有常數欄位 (Private Constant Field) 應使用 PascalCase (例如
MyPrivateConstant)。 - 公開靜態
readonly欄位 (Public StaticreadonlyField) 應使用 PascalCase (例如MyStaticReadonlyField)。 - 私有靜態
readonly欄位 (Private StaticreadonlyField) 應使用 PascalCase (例如MyPrivateStaticReadonlyField)。 - 列舉 (Enum) 應使用 PascalCase (例如
MyEnum)。 - 局部函式 (Local Function) 應使用 PascalCase (例如
MyLocalFunction())。 - 非欄位成員 (Non-Field Member) 應使用 PascalCase (例如
MyMember)。
此部分定義了不同符號型別的命名規則。
- 介面 (Interface)：適用於介面型別，包含
public、internal、private、protected、protected_internal和private_protected的可存取性，不需要修飾詞。 - 列舉 (Enum)：適用於列舉型別，包含
public、internal、private、protected、protected_internal和private_protected的可存取性，不需要修飾詞。 - 事件 (Event)：適用於事件成員，包含
public、internal、private、protected、protected_internal和private_protected的可存取性，不需要修飾詞。 - 方法 (Method)：適用於方法成員，包含
public、internal、private、protected、protected_internal和private_protected的可存取性，不需要修飾詞。 - 屬性 (Property)：適用於屬性成員，包含
public、internal、private、protected、protected_internal和private_protected的可存取性，不需要修飾詞。 - 公開欄位 (Public Field)：適用於
public和internal的欄位成員，不需要修飾詞。 - 私有欄位 (Private Field)：適用於
private、protected、protected_internal和private_protected的欄位成員，不需要修飾詞。 - 私有靜態欄位 (Private Static Field)：適用於
private、protected、protected_internal和private_protected的靜態欄位成員，需要static修飾詞。 - 型別和命名空間 (Type and Namespace)：適用於命名空間、類別、結構、介面和列舉，包含
public、internal、private、protected、protected_internal和private_protected的可存取性，不需要修飾詞。 - 非欄位成員 (Non-Field Member)：適用於屬性、事件和方法成員，包含
public、internal、private、protected、protected_internal和private_protected的可存取性，不需要修飾詞。 - 型別參數 (Type Parameter)：適用於命名空間，適用於任何可存取性，不需要修飾詞。
- 私有常數欄位 (Private Constant Field)：適用於
private、protected、protected_internal和private_protected的常數欄位成員，需要const修飾詞。 - 本地變數 (Local Variable)：適用於本地變數，適用於任何可存取性，不需要修飾詞。
- 本地常數 (Local Constant)：適用於本地常數，適用於任何可存取性，需要
const修飾詞。 - 參數 (Parameter)：適用於參數，適用於任何可存取性，不需要修飾詞。
- 公開常數欄位 (Public Constant Field)：適用於
public和internal的常數欄位成員，需要const修飾詞。 - 公開靜態
readonly欄位 (Public StaticreadonlyField)：適用於public和internal的靜態readonly欄位成員，需要static和readonly修飾詞。 - 私有靜態
readonly欄位 (Private StaticreadonlyField)：適用於private、protected、protected_internal和private_protected的靜態readonly欄位成員，需要static和readonly修飾詞。 - 局部函式 (Local Function)：適用於局部函式，適用於任何可存取性，不需要修飾詞。
- PascalCase：首字母大寫，單字之間無分隔符號，例如
MyClassName。 - IPascalCase：首字母為
I的 PascalCase，例如IMyInterface。 - TPascalCase：首字母為
T的 PascalCase，例如TMyType。 - _camelCase：首字母小寫，單字之間無分隔符號，並以底線
_開頭，例如_myVariable。 - camelCase：首字母小寫，單字之間無分隔符號，例如
myVariable。 - s_camelCase：首字母為
s_的 camelCase，例如s_myStaticVariable。
-
本規範應適用於所有 C# 程式碼。
所有團隊成員都應遵循此規範來編寫 C# 程式碼。
-
如有任何不清楚的地方，請諮詢團隊成員。
當您對規範有任何疑問或不確定之處時，請及時諮詢團隊成員，以確保對規範的理解一致。
-
本規範允許根據團隊需要進行更新和修改。
本規範不是一成不變的，可以根據團隊的需要進行調整和完善。