| name | csharp-code-style |
| description | C# code style and naming conventions based on POCU standards. Covers naming rules (mPascalCase for private, bBoolean prefix, EEnum prefix), code organization, C# 9.0 patterns. Use PROACTIVELY for C# code reviews, refactoring, or establishing project standards. |
C# Code Style Guide
Overview
C# 코딩 표준 (POCU 기반, C# 9.0 기준)
Core Topics:
- 명명 규칙 (m접두어, b접두어, E/S접두어)
- 코드 작성 규칙
- 클래스 구조 순서
- C# 9.0 패턴
Language Note
이 문서는 한국어를 기본으로 작성되었으며, 코드 예제와 기술 용어는 영어를 사용합니다.
섹션 제목은 영어로 통일하고, 설명과 주석은 한국어로 작성합니다.
- 섹션 제목: 영어 (Naming Conventions, Code Writing Rules 등)
- 설명/주석: 한국어
- 코드 예제: 영어 (변수명, 클래스명, 코드 코멘트)
- 표(Table) 헤더: 영어, 내용은 영어 또는 한국어 혼용 가능
Naming Conventions
Quick Reference
| Element | Convention | Example |
|---|
| Class | PascalCase | PlayerManager, OrderService |
| Struct | SPascalCase | SUserID, SPlayerData |
| Interface | IPascalCase | IDisposable, IOrderService |
| Enum | EPascalCase | EDirection, EOrderStatus |
| Method (public) | PascalCase (동사+명사) | GetAge(), ProcessOrder() |
| Method (private) | camelCase | getAge(), processOrder() |
| Property | PascalCase | Name, OrderID |
| Private Field | mPascalCase | mAge, mOrderRepository |
| Local Variable | camelCase | totalAmount, isValid |
| Parameter | camelCase | customerId, orderDate |
| Constant | ALL_CAPS | MAX_RETRY_COUNT, DEFAULT_TIMEOUT |
| Static readonly | ALL_CAPS | MY_CONST_OBJECT |
| Boolean Variable | bCamelCase / mbPascalCase | bFired, mbIsEnabled |
| Boolean Property | Is/Has/Can/Should | IsFired, HasChildren |
Private Member Pattern
public class OrderService
{
private readonly IOrderRepository mOrderRepository;
private readonly ILogger mLogger;
private int mRetryCount;
private bool mbIsProcessing;
public OrderService(IOrderRepository orderRepository, ILogger logger)
{
mOrderRepository = orderRepository;
mLogger = logger;
}
public Order GetOrder(int orderId)
{
return getOrderInternal(orderId);
}
private Order getOrderInternal(int orderId)
{
return mOrderRepository.Find(orderId);
}
}
Enum and Struct Prefixes
public enum EDirection
{
None,
North,
South,
East,
West
}
[Flags]
public enum EVisibilityFlags
{
None = 0,
Visible = 1,
Hidden = 2,
Collapsed = 4
}
public struct SUserID
{
public int Value { get; }
}
public readonly record struct UserID(int Value);
Nullable Naming
public Animation GetAnimation(string nameOrNull)
{
if (nameOrNull == null)
{
return DefaultAnimation;
}
return mAnimations[nameOrNull];
}
public string GetNameOrNull()
{
return mbHasName ? mName : null;
}
public int FibonacciRecursive(int n)
{
if (n <= 1)
{
return n;
}
return FibonacciRecursive(n - 1) + FibonacciRecursive(n - 2);
}
Code Writing Rules
Prohibited Patterns
var order = GetOrder(1);
var items = new List<Item>();
Order order = GetOrder(1);
List<Item> items = new List<Item>();
string name = inputName ?? "Default";
string name;
if (inputName != null)
{
name = inputName;
}
else
{
name = "Default";
}
using FileStream stream = new FileStream(path, FileMode.Open);
using (FileStream stream = new FileStream(path, FileMode.Open))
{
}
List<Order> orders = new();
List<Order> orders = new List<Order>();
public async Task<Order> GetOrderAsync(int id);
public async Task<Order> GetOrder(int id);
if (int.TryParse(input, out int result))
int result;
if (int.TryParse(input, out result))
Required Patterns
if (condition)
{
DoSomething();
}
float value = 0.5f;
float another = 1.0f;
switch (status)
{
case EStatus.Active:
Process();
break;
case EStatus.Inactive:
Skip();
break;
default:
Debug.Fail("Unknown status");
break;
}
Debug.Assert(order != null, "Order should not be null");
Debug.Assert(count > 0, "Count must be positive");
public int GetAge() { return mAge; }
public void SetAge(int age) { mAge = age; }
public int Age { get; private init; }
public int Age { get; private set; }
C# 9.0 Patterns
Unity Limitation: init accessor is NOT available in Unity (requires .NET 5+ runtime).
See Modern Patterns Reference for details and alternatives.
public class Customer
{
public string Name { get; private init; }
public string Email { get; private init; }
}
public record OrderDto(int Id, string CustomerName, decimal TotalAmount);
public string GetStatusMessage(EOrderStatus status)
{
return status switch
{
EOrderStatus.Pending => "Order is pending",
EOrderStatus.Completed => "Order completed",
_ => throw new ArgumentOutOfRangeException(nameof(status))
};
}
Class Structure Order
public class OrderService : IOrderService
{
private const int MAX_RETRY_COUNT = 3;
public static readonly TimeSpan DEFAULT_TIMEOUT = TimeSpan.FromSeconds(30);
private readonly IOrderRepository mOrderRepository;
private readonly ILogger mLogger;
private int mProcessedCount;
private bool mbIsInitialized;
public int ProcessedCount => mProcessedCount;
public bool IsInitialized => mbIsInitialized;
public OrderService(IOrderRepository orderRepository, ILogger logger)
{
mOrderRepository = orderRepository;
mLogger = logger;
}
public Order GetOrder(int id)
{
Debug.Assert(id > 0, "ID must be positive");
return mOrderRepository.Find(id);
}
public void ProcessOrder(Order order)
{
validateOrder(order);
processInternal(order);
}
private void validateOrder(Order order)
{
Debug.Assert(order != null);
}
private void processInternal(Order order)
{
}
}
File Organization
- 각 클래스는 독립된 파일에 작성
- 파일명 = 클래스명 (정확히 일치)
- Partial 클래스:
ClassName.SubName.cs
Reference Documentation
Complete naming rules:
- m/mb 접두어 상세
- E/S 접두어 규칙
- OrNull 접미어 패턴
- ALL_CAPS 상수 규칙
C# 9.0 language features:
- Records and init-only properties
- Pattern matching
- File-scoped namespaces (C# 10)
- 금지 패턴 상세
Error handling patterns:
- Debug.Assert 사용
- 경계에서만 예외 처리
- null 반환/매개변수 회피
- 유효성 검증 패턴
Key Principles
- 가독성 최우선: 명확하고 이해하기 쉬운 코드 작성
- 명시적 타입:
var 사용 금지, 타입 명시
- Null 안전: OrNull 접미어로 nullable 명시
- Assertion: 모든 가정에 Debug.Assert 사용
- 경계 검증: 외부 데이터는 경계에서만 검증
- Use init: Prefer C# 9.0 private init (.NET 5+ only, NOT available in Unity)
- No Emoji: 코드 예제 및 문서에서 이모지 사용 금지, 텍스트 태그 사용 ([WRONG], [CORRECT], [CAUTION])