C# 명명 규칙 (개발자를 위한 작동 방식)

명명 규칙 개요

public class Customer
{
    public decimal Balance { get; set; }
}

public interface ICustomer
{
    decimal GetBalance();
}

public class Customer
{
    public decimal Balance { get; set; }
}

public interface ICustomer
{
    decimal GetBalance();
}

Public Class Customer
	Public Property Balance() As Decimal
End Class

Public Interface ICustomer
	Function GetBalance() As Decimal
End Interface

public decimal CalculateInterest(decimal principal, decimal rate)
{
    return principal * rate;
}

public decimal CalculateInterest(decimal principal, decimal rate)
{
    return principal * rate;
}

Public Function CalculateInterest(ByVal principal As Decimal, ByVal rate As Decimal) As Decimal
	Return principal * rate
End Function

public DateTime DateOpened { get; set; }
public decimal Reserves { get; set; }

public DateTime DateOpened { get; set; }
public decimal Reserves { get; set; }

Public Property DateOpened() As DateTime
Public Property Reserves() As Decimal

로컬 변수와 메소드 인수

로컬 변수와 메소드 인수는 camel case를 사용해야 합니다. 이는 첫 단어가 소문자로 시작하며, 뒤따르는 단어는 대문자로 시작하고 공백이나 밑줄이 없음을 의미합니다. 첫 글자가 대문자가 아닌 점이 Pascal Case와 다릅니다.

public void SelectCustomer(string customerName)
{
    var selectedCustomer = FindCustomer(customerName);
}

public void SelectCustomer(string customerName)
{
    var selectedCustomer = FindCustomer(customerName);
}

Public Sub SelectCustomer(ByVal customerName As String)
	Dim selectedCustomer = FindCustomer(customerName)
End Sub

이 예제에서, 지역 변수 selectedCustomer 는 camel case 관례를 따르며, 메소드 매개변수 customerName 또한 camel case로 작성됩니다.

public void AddCustomer(string customerName, DateTime dateOpened)
{
    // Add customer logic
}

public void AddCustomer(string customerName, DateTime dateOpened)
{
    // Add customer logic
}

Public Sub AddCustomer(ByVal customerName As String, ByVal dateOpened As DateTime)
	' Add customer logic
End Sub

정적 멤버와 필드

클래스의 정적 멤버, 예를 들어 정적 필드, 상수, 메소드는 특정 명명 규칙을 따릅니다.

private static int _totalCustomers;

private static int _totalCustomers;

Private Shared _totalCustomers As Integer

public const int MAX_CUSTOMERS = 100;

public const int MAX_CUSTOMERS = 100;

Public Const MAX_CUSTOMERS As Integer = 100

private void OnCustomerAdded(object sender, EventArgs e)
{
    // Event handling logic
}

private void OnCustomerAdded(object sender, EventArgs e)
{
    // Event handling logic
}

Private Sub OnCustomerAdded(ByVal sender As Object, ByVal e As EventArgs)
	' Event handling logic
End Sub

프라이빗 필드와 객체 초기화자 명명

프라이빗 필드는 camel case 규칙을 따르되 밑줄 접두사를 사용해야 합니다. 이는 로컬 변수와 메소드 인수와 구별하는 데 도움이 됩니다.

private string _customerName;

private string _customerName;

Private _customerName As String

객체 초기화자를 사용할 때, 클래스의 인스턴스를 생성할 때 속성에 값을 직접 할당할 수 있습니다:

var seattleCustomer = new Customer
{
    Balance = 1000,
    DateOpened = DateTime.Now
};

var seattleCustomer = new Customer
{
    Balance = 1000,
    DateOpened = DateTime.Now
};

Dim seattleCustomer = New Customer With {
	.Balance = 1000,
	.DateOpened = DateTime.Now
}

이 예제에서, 속성 이름 Balance 와 DateOpened 는 Pascal Case이므로 속성의 관례를 따릅니다.

예외 처리 및 메소드

예외를 처리할 때, 메소드 이름은 여전히 Pascal Case 규칙을 따라야 합니다. 예외 클래스 이름도 Pascal Case로 되어 있어야 하며 Exception 접미사로 끝나야 합니다. 예를 들어:

public void ProcessTransaction()
{
    try
    {
        // Transaction logic
    }
    catch (InvalidOperationException ex)
    {
        // Handle exception
    }
}

public void ProcessTransaction()
{
    try
    {
        // Transaction logic
    }
    catch (InvalidOperationException ex)
    {
        // Handle exception
    }
}

Public Sub ProcessTransaction()
	Try
		' Transaction logic
	Catch ex As InvalidOperationException
		' Handle exception
	End Try
End Sub

public decimal CalculateTotalBalance()
{
    return _totalCustomers * balancePerCustomer;
}

public decimal CalculateTotalBalance()
{
    return _totalCustomers * balancePerCustomer;
}

Public Function CalculateTotalBalance() As Decimal
	Return _totalCustomers * balancePerCustomer
End Function

C# 상수 명명 규칙

C#에서, 상수 이름은 모든 대문자로 되어야 하며, 밑줄로 단어를 구분합니다. 이것은 상수를 다른 변수와 구분되게 합니다. 다음은 예시입니다.

public const double PI = 3.14159;

public const double PI = 3.14159;

Public Const PI As Double = 3.14159

이 규칙은 다양한 유형에 걸쳐 적용되며, 상수 이름이 일관성이 있고 코드에서 쉽게 인식되도록 보장합니다.

C# 코딩 컨벤션: 줄 바꿈 및 중괄호

C#에는 줄 바꿈과 중괄호에 대한 코딩 규칙도 있습니다. C#에서, 각 여는 중괄호 {는 해당 문장과 같은 라인에 있어야 하고, 닫는 중괄호 }는 새로운 라인에 있어야 하며, 해당 문장과 정렬되어야 합니다. 다음은 예시입니다.

public void AddCustomer(string customerName)
{
    if (!string.IsNullOrEmpty(customerName))
    {
        _customerName = customerName;
    }
}

public void AddCustomer(string customerName)
{
    if (!string.IsNullOrEmpty(customerName))
    {
        _customerName = customerName;
    }
}

Public Sub AddCustomer(ByVal customerName As String)
	If Not String.IsNullOrEmpty(customerName) Then
		_customerName = customerName
	End If
End Sub

적절한 서식을 사용하면 코드를 읽고 따라가기가 더 쉬워집니다.

헝가리언 표기법 피하기

현대 C# 개발에서는 변수 이름에 데이터 유형을 접두어로 붙이는 헝가리언 표기법(예: 문자열의 경우 strName, 정수의 경우 intCount)은 권장되지 않습니다. 대신 변수의 데이터 유형보다는 용도를 설명하는 의미 있는 이름을 사용하십시오:

public string CustomerName { get; set; }
public int OrderCount { get; set; }

public string CustomerName { get; set; }
public int OrderCount { get; set; }

Public Property CustomerName() As String
Public Property OrderCount() As Integer

이 접근 방식은 코드를 더 명확하고 유지보수하기 쉽게 만듭니다.

명명 규칙과 함께 IronPDF 사용

C# 프로젝트에 IronPDF를 통합할 때 명명 규칙을 따름으로써 깨끗하고 읽기 쉬운 코드를 유지하는 것이 중요합니다. IronPDF를 사용하면 C# 애플리케이션 내에서 HTML 콘텐츠에서 PDF를 생성할 수 있습니다. 이렇게 할 때 클래스, 메서드 및 변수에 대한 명명 규칙을 따르는 것이 중요합니다. 아래는 IronPDF를 사용하여 코드 가독성을 향상시키기 위한 명명 규칙의 간단한 구현 예시입니다:

using IronPdf;

public class PdfReportGenerator
{
    private readonly string _htmlContent;
    private readonly string _filePath;

    public PdfReportGenerator(string htmlContent, string filePath)
    {
        _htmlContent = htmlContent;
        _filePath = filePath;
    }

    public void GenerateReport()
    {
        var pdfRenderer = new ChromePdfRenderer();
        PdfDocument pdfDocument = pdfRenderer.RenderHtmlAsPdf(_htmlContent);
        pdfDocument.SaveAs(_filePath);
    }
}

public static class Program
{
    public static void Main()
    {
        var htmlContent = "<h1>Monthly Report</h1><p>Generated using IronPDF.</p>";
        var filePath = @"C:\Reports\MonthlyReport.pdf";
        PdfReportGenerator reportGenerator = new PdfReportGenerator(htmlContent, filePath);
        reportGenerator.GenerateReport();
    }
}

using IronPdf;

public class PdfReportGenerator
{
    private readonly string _htmlContent;
    private readonly string _filePath;

    public PdfReportGenerator(string htmlContent, string filePath)
    {
        _htmlContent = htmlContent;
        _filePath = filePath;
    }

    public void GenerateReport()
    {
        var pdfRenderer = new ChromePdfRenderer();
        PdfDocument pdfDocument = pdfRenderer.RenderHtmlAsPdf(_htmlContent);
        pdfDocument.SaveAs(_filePath);
    }
}

public static class Program
{
    public static void Main()
    {
        var htmlContent = "<h1>Monthly Report</h1><p>Generated using IronPDF.</p>";
        var filePath = @"C:\Reports\MonthlyReport.pdf";
        PdfReportGenerator reportGenerator = new PdfReportGenerator(htmlContent, filePath);
        reportGenerator.GenerateReport();
    }
}

Imports IronPdf

Public Class PdfReportGenerator
	Private ReadOnly _htmlContent As String
	Private ReadOnly _filePath As String

	Public Sub New(ByVal htmlContent As String, ByVal filePath As String)
		_htmlContent = htmlContent
		_filePath = filePath
	End Sub

	Public Sub GenerateReport()
		Dim pdfRenderer = New ChromePdfRenderer()
		Dim pdfDocument As PdfDocument = pdfRenderer.RenderHtmlAsPdf(_htmlContent)
		pdfDocument.SaveAs(_filePath)
	End Sub
End Class

Public Module Program
	Public Sub Main()
		Dim htmlContent = "<h1>Monthly Report</h1><p>Generated using IronPDF.</p>"
		Dim filePath = "C:\Reports\MonthlyReport.pdf"
		Dim reportGenerator As New PdfReportGenerator(htmlContent, filePath)
		reportGenerator.GenerateReport()
	End Sub
End Module

이 명명 규칙을 준수하면 보고서를 생성하기 위해 IronPDF를 사용할 때 코드가 전문적이고 체계적이며 읽기 쉽습니다.

결론

이러한 C# 명명 규칙을 따르면 코드가 깨끗하고 읽기 쉽고 유지보수하기 쉬움을 보장할 수 있습니다. 클래스 이름에 Pascal 케이스, 로컬 변수에 camel 케이스, 개인 필드에 밑줄 접두어를 사용하는 등의 방법은 일관된 코드베이스를 구축하는 데 도움이 됩니다.

IronPDF를 통해 무료 체험판으로 모든 기능을 탐색할 수 있습니다. 이 체험판을 통해 워크플로우에 얼마나 잘 통합되는지를 직접 실험하고 확인할 수 있습니다. 다음 단계로 넘어갈 준비가 되면, 라이선스는 단지 $799 부터 시작합니다.