코딩 관례(convention)

Convention의 뜻은 관습, 관례이다. 코딩 컨벤션이란 프로그램의 소스 코드 작성 시 코딩 방식과 규칙을 정하고 그것을 따름을 의미한다.

무조건 따라야 할 절대적인 이유는 없지만, 몇 가지 장점이 있기에 대체로 프로젝트를 시작할 때 미리 규약을 정의하고 개발자들이 따르도록 하는 경우가 많다.

코딩 방식(style)

인간은 저마다 개성을 가진 고귀한 존재이므로, 소스 코드 작성 시에도 그 개성을 나타낸다. 같은 로직을 표현하는데도 다른 외관이 나타날 수 있는데, 사실 컴파일러가 코드를 해석하는데는 아무 상관이 없다.

프로그래밍 언어마다 전통적이고 유명한 코딩 방식이 존재하고, 개발자는 보통 그 중 하나를 택하여 그대로 사용하거나, 개인화(customizing)하여 사용하기도 한다.

가끔 코딩 방식 없이 일관되지 못하게 짜놓은 코드를 보는 경우가 있는데, 아무리 좋은 로직이라 하더라도 소스 코드의 질이 굉장히 떨어져 보인다.

관례를 따랐을 때의 장점

소스 코드의 가독성 향상

소스 코드를 최초에 작성하는 사람이 존재한다면, 추후에 그 소스 코드를 수정해야 하는 사람 또한 존재할 것이고 그 둘이 같은 사람이라고 보장할 수 없다. 그렇기 때문에 최초 작성자는 본인이 아닌 다른 사람이 자신의 소스 코드를 볼 수 있다는 점과 이해하기 쉽도록 만들어야 한다는 점을 간과해서는 안 된다.

그리고 프로그램은 여러 사람이 함께 만드는 일이 많기 때문에, 각자의 방식으로 소스 코드를 작성하면 전체적인 소스 코드가 일관되지 못하게 된다.

결국 유지보수에 있어서 관례를 따르는 것은 충분한 장점이 있다.

소스 코드의 품질 향상

소스 코드를 깔끔하게 작성하게 되면 그 소스 코드를 잘 이해할 수 있게 되고 구조를 파악하기 용이해진다. 흐름을 잘 이해하게 되면 코딩 실수를 방지할 수 있고 잠재적인 버그 발생을 억제할 수 있다.

소스 코드의 품질 향상은 프로그램의 품질 향상으로 이어진다.

관례의 종류

들여쓰기 방식 관례

들여쓰기 방식은 코드 블록의 들여쓰기를 통해 프로그램의 구조를 나타내는 관례이다.

탭, 공백, 들여쓰기 크기

들여쓰기 방식은 코드 블록 왼쪽에 탭 또는 공백을 넣어 들여쓰기를 함으로써 프로그램의 구조와 코드의 종속적인 관계를 표현하는 기법이다.

탭은 tab 키를 사용하여 표현하고, 공백은 space 키를 사용한다. 탭은 일정 수의 공백을 대신하는데 일반적으로 소스 코드 편집기 차원에서 설정할 수 있다.

일반적으로 탭 폭은 2, 4, 8을 사용한다.

탭은 제어 코드 하나로 여러 개의 공백을 표현할 수 있기 때문에 문서 크기가 작아진다는 장점이 있지만, 편집기에 따라 탭의 크기가 다르기 때문에 소스 코드가 의도한 것과는 다르게 보일 수도 있다.

탭폭이 4인 편집기로 잘 정렬하여 작성한 코드를 탭폭이 8인 편집기로 열게 되면 정렬 상태가 엉망이 되어버린다. 또한 탭폭이 같더라도 고정폭이 아닌 가변폭 글꼴을 사용하게 될 때도 틀어질 수 있다.

탭 문자는 절대적이지 않고 주변 상황에 따라 위치가 결정되는 논리적인 포맷 지정을 하기 때문이다.

항상 같은 편집기를 사용한다고 가정하면 탭을 사용하는 것이 편리하다. 하지만 여러 편집기를 같이 사용하거나 다른 사람과 함께 코딩을 한다면 문제가 된다.

탭 대신 공백을 사용하고 고정폭 글꼴을 사용하면 편집기에 영향을 받지 않고 항상 일정한 모양을 유지할 수 있다. 대신에 스페이스를 여러 번 눌러야 한다는 귀찮음과 문서의 크기(byte)가 커지는 단점이 있다.

많은 초기 프로그램들은 들여쓰기를 Tab 문자로 사용했다. 간편하고 소스 파일 크기를 절약할 수 있기 때문이다. (Tab 문자 하나가 4칸의 들여쓰기를 한다고 치면 Space 문자는 4개가 필요함.)

일반적으로 유닉스 편집기는 탭을 8개의 문자로, 매킨토시와 MS 윈도우즈는 4개의 문자로 본다. 그래서 코드를 옮길 때 혼란을 가중시킨다.

현대의 프로그래밍 편집기는 종종 임의의 들여쓰기 크기를 사용하곤 한다. 많은 쉘 프로그래밍 언어, 루비, HTML 등에서 들여쓰기 단계마다 공백 두개를 사용한다.

소스 코드의 한 줄을 몇 자로 제한할 것인지에 대한 관례도 존재한다. 과거 도스 환경의 영향으로 80자로 제한하는 것이 보통이고, 최대 100자까지 허용하는 것이 추세인 것 같다.

hard tab = 키보드의 탭 키의 원래 기능을 의미한다. (0x9)

soft tab = 소스 코드 편집기에서 지원하는 기능으로 탭 키를 임의의 개수의 공백(space, 0x20)로 실시간 치환해준다.

도구

자동으로 들여쓰기 방식을 변경해주는 도구도 존재한다.

들여쓰기 방식

모든 방식을 다 살펴볼 필요는 없을 것 같고, 대표적인 방식 몇 가지를 분석해보겠다.

K&R 방식

자바 코딩 관례에서 사용하는 방식이다. 한국에서 가장 많이 쓰이고 있다고 한다?

Dennis Ritchie(C 창시자)와 Brian Kernighan이 쓴 저서 'The C Programming Language'라는 책에서 사용한 방식으로 C와 C++에서 많이 사용된다.

C++의 창시자인 Bjarne Stroustrup도 이 방식을 사용한다.

public static void main(String[] args)
{
while (x == y) {
something();

if (some_error) {
do_correct();
} else {
continue_as_usual();
}
}
}

각 함수는 선언부와 같은 들여쓰기 수준(level)의 다음 줄에 여는 중괄호(brace)를 가진다.

중괄호 내의 문장은 들여쓰고 닫는 중괄호는 선언부의 들여쓰기 수준에 맞춘다.

하지만 함수 내부의 블록(제어문 등)은 선언부의 오른쪽 끝에 여는 중괄호를 가진다.

장점

함수 내부 블록의 여는 괄호가 따로 한 줄을 차지하지 않아 수직으로 더 많은 코드를 볼 수 있다.

단점

여는 중괄호와 닫는 중괄호의 수평 위치가 다르기 때문에 블록 중첩이 많아지면 블록의 시작과 끝을 찾기 어렵다.

소스 코드가 많아지면 가독성이 떨어진다.

선언부를 주석 처리할 때 조금 불편하다.

변형 : 1TBS 방식

1TBS = One True Brace Style

제어문이 간단하다고 하더라도 중괄호를 생략하지 않는 방식이다.

AS-IS

if (some_error)
do_correct();
else
continue_as_usual();

TO-BE

if (some_error) {
do_correct();
} else {
continue_as_usual();
}

변형 : Stroustrup

C++의 창시자인 Bjarne Stroustrup이 C++을 위하여 K&R 방식을 변형한 것이다.

닫는 중괄호와 다음 블록의 여는 중괄호를 한 줄에 위치시키지 않는 방식이다.

AS-IS

if (some_error) {
do_correct();
} else {
continue_as_usual();
}

TO-BE

if (some_error) {
do_correct();
}

else {
continue_as_usual();
}

Exdented 또는 Allman 또는 BSD 방식

많은 BSD Unix를 위한 유틸리티를 만든 Eric Allman에 의해 이름 붙여졌다.

GNU 방식과 K&R 방식의 장점만을 취한다.

함수 선언문 뿐만 아니라 함수 내부의 블록 또한 여는 중괄호가 선언부 다음줄에 위치한다.

public static void main(String[] args)
{
while (x == y)
  {
      something();

      if (some_error)
      {
          do_correct();
      }
      else
      {
          continue_as_usual();
      }
  }
}

장점

블록의 시작과 끝이 명확하게 보이기 때문에 가독성이 높다.

단점

여는 중괄호가 항상 따로 한줄을 차지하기 때문에 수직으로 보는 코드양이 적어진다. 아래 위로 스크롤해가며 봐야 함. 인쇄 시 종이의 낭비가 심하다는 경제적인 문제도 있다. 이런 이유들로 예전에는 K&R 방식이 많이 사용되었지만, 고해상도 모니터의 보급화로 인해 점점 Allman 방식을 사용하는 추세이다.