본문 바로가기

카테고리 없음

코딩 컨벤션 (Coding Convention)

반응형

 코딩 컨벤션(Coding Convention)은 코딩 표준, 코딩 스타일이라고 하며, 가독성이 좋고 일관된 코드 즉, 클린 코드를 작성하고 이를 유지하기 위해 어떻게 코드를 작성해야 하는지 암묵적으로 정해진 규칙입니다. 이러한 코딩 컨벤션 중 언어별로 공통적으로 통용되는 컨벤션에 대해 몇 가지 알아보겠습니다.

 

네이밍 규칙

 첫번째로 살펴볼 네이밍 규칙은 파스칼 케이싱(Pascal Casing)입니다. 이는 클래스, 열거형, 이벤트 등의 이름을 만들 때 대문자로 시작하고, 복합어일 경우에 중간에 시작하는 새로운 단어를 대문자로 적는다는 규칙입니다. 파스칼 케이싱의 예시로는 UserClass, MainFrame, SubFrame 등이 있습니다. 다음으로는 카멜 케이싱 (Camel Casing)입니다. 카멜 케이싱은 함수의 매개변수 이름에 적용되는 첫 번째 문자는 소문자로 시작한다는 규칙으로, 주로 자바에서 많이 사용됩니다. 이때 매개변수 이름이 복합어일 경우에는 파스칼 케이싱과 동일하게 적용합니다. 해당 예시로는 userClass, mainFrame, subFrame 등이 있습니다. 스테이크 케이스 (Snake Case)는 복합어 사이를 언더바(_)로 연결하는 규칙으로, user_class, main_frame, sub_frame와 같은 형식으로 작성합니다. 마지막으로 상수(Constant)는 거의 모든 명명법에서 표기하는 방법이 동일하고, 모든 문자를 대문자로 사용하며, 복합어 사이를 언더바(_)로 연결합니다.

 

암묵적인 네이밍 규칙

 앞서 소개한 네가지 네이밍 규칙 외에도 암묵적으로 지켜지고 있는 네이밍 규칙들이 존재합니다. 변수의 클래스에는 동시 사용을 지양하며, 함수에는 코드의 기능을 알 수 있는 동사를 사용합니다. 또한 변수명에서는 관사 및 전치사를 사용하지 않고, 복수 사용을 지향합니다. 그리고 통상적으로 사용되는 변수명과 규칙을 사용하고, 상수는 모두 대문자를 사용합니다. 마지막으로 변수가 길어질 경우에는 축약하는 것을 암묵적인 네이밍 규칙으로 하고 있습니다.

 

스타일 규칙

 그 외의 스타일 규칙으로는 들여 쓰기의 습관화, 연산자 사이 공백, 괄호 사이 불필요한 공백 제거, 주석은 되도록 짧게 축약하는 등의 규칙과, 공백은 가독성 향상을 위해서만 사용한다는 규칙 등이 존재합니다.

 

 이러한 코딩 컨벤션을 따르면 가독성을 높이는 등 클린 코드(좋은 코드)에서 얻을 수 있는 장점들을 얻을 수 있지만, 해당 언어를 충분히 이해하지 못한 상태에서 표준을 따르기에는 어렵고, 코드 구현 시에 창의성이 감소하며, 코드 구조를 지나치게 강제할 수 있다는 단점 또한 가지고 있습니다.

반응형