코딩 가이드를 따르십니까?

코딩 규칙은 두 종류로 나뉩니다. 하나는 자동으로 스타일을 바꿀 수 있는 것 하나는 힘들여 코딩가이드를 따라야만하는 것입니다. 코딩 규칙은 너무나 개인 적인 성향이 강하게 나타나므로 팀이 개발 할 경우에 걸림돌이 될 수 있습니다. 대개 코딩 가이드는

이름(파일, 함수, 클래스)을 어떻게 정할 것인가?
주석을 어떻게 달 것인가?
괄호의 위치는 어떻게 할 것인가?
들여쓰기는 어떻게 할 것인가?

등의 커다란 주제로 나뉩니다. 그중에서 자동화 하거나 규칙을 어겼는지를 테스트하여 경고를 줄 수 없다면, 코드 리뷰를 하기전까지는 알 수가 없습니다. 과거에는 코딩 규칙만 정해놓고 따르지 않는 경우가 허다했습니다. 습관과 관계되었기 때문입니다. 하지만 요즘에는 code beautifier가 많기 때문에 마음대로 작성하고 코딩 규칙에 맞는 option을 선택하여 code beautifier를 돌려주면 됩니다.

구글로 code beautifier 혹은 source beautifier 로 검색하면 상당히 많은 검색을 얻을 수 있을 것입니다. 제가 즐겨쓰는 것은 GNU의 indent입니다. indent 자체에는 GNU style과 BSD style로 맞춰주도록 하는 옵션이 있어서, 많은 GNU tool이나 BSD tool들이 이런 유틸리티의 산출물 형태로 등록되는 것을 볼 수 있습니다.

코딩 규칙에는 파일 이름 정하는 것이나 함수 이름, 변수 이름등을 결정하는 것이 따라 갑니다. 이들 또한 ctags -x 를 사용하면 함수와 변수별로 정의된 위치를 파악할 수 있습니다. 함수,변수 이름 규칙은 반드시 정규표현식으로 결정할 수 있어야하고, ctags -x 의 출력물을 정규표현식으로 하나하나 조사하여 규칙 위반 여부를 리포팅하는 것도 코딩 규칙이 문서로만 존재하는 것을 막아 주게 됩니다.