SW 기능/C#

코딩 컨벤션

tacoyaggi 2023. 11. 15. 14:32

개념

  • 일종의 코딩 스타일 규약으로 모든 구성원들이 읽고 관리하기 쉬운 코드를 작성하는 것
  • 이를 통해 잠재적인 오류를 줄일 수 있고 가독성이 높아지게 되어 다른 개발자가 작성한 코드를 이해하는데 도움을 주어 유지보수에 도움이 된다. 

규칙

  • 인터페이스 이름은 대문자 I 로 시작
  • 특성 유형은 Attribute 단어로 끝
  • 식별자에는 두 개의 연속된 밑줄 _ 포함되면 안된다. 
  • 클래스명 및 메서드명 에는 PascalCase를 사용
  • 메서드 인수, 지역 변수 및 private 필드에는 camelCase 사용
  • 필드와 상수에는 PascalCase 사용
  • private 인스턴스 필드는 밑줄 시작

파스칼 케이스(Pascal Case)

  • struct
  • class
    • public class MyClassName
      {
          // 클래스 멤버들...
      }
  • interface
    • 인터페이스 앞에는 대문자 I 넣는다.  
    • public interface IMyInterface
      {
          // 인터페이스 멤버들...
      }
  • enum
  • method 및 속성
    • public class MyClass
      {
          public void MyMethod() { /* ... */ }
          public int MyProperty { get; set; }
      }
  • 네임스페이스
  • 생성자
  • 상수

카멜 케이스(Camel Case)

  • 변수 및 인자
    • public class MyClass
      {
          public int myVariable;
          public void MyMethod(int myParameter) { /* ... */ }
      }