[c#] C# 코드 리뷰에서의 코드 스타일 가이드라인
코드 리뷰는 효과적인 소프트웨어 개발 및 유지보수에 중요한 역할을 합니다. C# 코드 스타일을 일관적으로 유지하면 코드를 이해하기 쉽고 관리하기 쉬워지며, 효율적인 협업을 가능하게 합니다. 이를 위해 다음과 같은 C# 코드 스타일 가이드라인을 따르는 것이 좋습니다.
1. 명명규칙
-
클래스 및 속성: 파스칼 케이스를 사용하여 첫 글자를 대문자로 하고 각 단어의 첫 글자를 대문자로 작성합니다. 예:
MyClass,MyProperty -
메서드 및 변수: 카멜 케이스를 사용하여 첫 글자를 소문자로 하고 각 단어의 첫 글자를 대문자로 작성합니다. 예:
myMethod, myVariable
2. 들여쓰기
들여쓰기에는 탭을 사용하며, 4개의 공백으로 설정합니다.
예시:
public class MyClass
{
public void MyMethod()
{
int myVariable = 10;
if (myVariable > 5)
{
// 코드 블록
}
}
}
3. 중괄호 사용
중괄호는 항상 다음과 같이 사용합니다.
- 중괄호는 새로운 줄에서 시작합니다.
- 닫는 중괄호(
})는 별도의 새로운 줄에 위치하며, else 구문을 제외하고 중괄호를 생략하지 않습니다.
if (condition)
{
// 코드 블록
}
else
{
// 코드 블록
}
4. 주석
- 메서드나 클래스에 대한 설명은 XML 주석을 사용하여 작성합니다.
/// <summary> /// 메서드에 대한 설명 /// </summary> /// <param name="param">파라미터 설명</param> /// <returns>반환 값 설명</returns> public void MyMethod(int param) { // 메서드 내용 } - 한 줄 주석은
//를 사용하며, 주석 앞에는 공백을 넣지 않습니다.
5. 문법 및 스타일
- 코드 블록 안에서 중괄호 생략을 피하고, 항상 사용하여 가독성을 높입니다.
- else 문과 단일 문장 if 문을 중괄호({})로 묶어줍니다.
이러한 가이드라인을 따르면서 코드 리뷰 과정에서 팀원들 간에 일관성을 유지하고 효율적으로 협업할 수 있습니다.