좋은 코드를 작성하는 방법. 코딩 스타일.

 

우리가 프로그래밍을 할 때 가장 눈에 보이는 결과물로써 존재하는 것이 '코드'입니다. 구현해놓은 모든 논리 순서 ( 알고리즘 ) 들이 결과물로써 코드가 존재하기 때문입니다. 또한 유지보수 및 디버깅이라는 것은 설계도인 ' 코드 ' 를 보고 하게 됩니다. 결론적으로 코드는 가장 중요한 프로그래밍에서의 결과물입니다. 그런데 이러한 코드를 마구자비로 작성하게되면 어떻게 될까요? 컴파일에는 상관이없겠지만 (기계는 얼마나 보기 좋게 썼는가를 신경쓰지 않으므로 ) 사람이 보기에는 매우 불편할것입니다. 그것들이 쌓여 유지보수 비용이 늘어나게되고 결국 그 감수는 코드를 작성한 사람이 해야하는 것입니다. 

 

 그래서 처음 코드를 작성할 때 부터 사람이 보기 좋은 코드를 작성해야 하는 것입니다.  평상시에 우리가 작성하고 사용하는 코드를 한번 보도록 하겠습니다.

 

코드

#include <stdio.h> int main ( int argc , char * argv[]  ) {       printf("Hello World!\n");       return 0; }

 

 누구나 만들어본다는 hello world 예제입니다. 현재 작성되어있는 코드를 보면 정말 읽기에 편합니다. 각 괄호들이 어떤 괄호와 연결되어 있는지 위치로써 표현되어있으며 앞에 빈칸을 줌으로써 포함관계를 표현하였습니다. 이런식으로 작성되어있는 코드는 "읽기에 좋은 코드" 입니다. 즉 좋은 코드죠.

 

 이런 읽기에 좋은 코드를 작성하는 스타일은 고정되어있지않습니다. 다양한 사람들이 다양한 방식으로 코드를 작성하죠. 그중 대표적이고 사람들이 많이 사용하는 스타일을 소개하도록 하겠습니다.

 

 

코드

#include <stdio.h> int main ( int argc , char * argv[]  ){       printf("Hello World!\n");       return 0; }

 

 단순히 열어주는 { 를  위에 붙여 놓은 형태입니다.  하지만 { 가 차지하고 있는 한줄만을 줄여준것 뿐인데 코드의 줄 수가 줄어듭니다. 또한 코드를 읽는데 전혀 불편함도 없습니다. 

 

 아주 옛날 코드를 보면 이런 스타일도 있습니다.

 

코드

#include <stdio.h> int main ( int argc , char * argv[]  )       {              printf("Hello World!\n");              return 0;       }

 

 보기에도 좋고 직관적이지만 옆으로 긴 코드를 작성하기에 불편하다는 이유로 요즘은 많이 안쓰입니다. 개인적으론 아직 코딩에 익숙하지 않을 땐 첫번째 방법 (맨위) 을 추천드립니다. 아직 포함관계나 여러 지역변수를 정확하게 파악하기 힘들기 때문에 완벽하게 { } 를 사용하는 첫번째 코드가 더 좋습니다. 익숙해지신다면 여러가지 방식으로 사용하셔도 됩니다. 

 

 

 

또한 변수의 이름이나 함수의 이름에 대해서도 a , b , c 등 의미가 없는 알파벳을 쓰는 것보단 temp , sum , func 등 의미를 가지는 단어를 사용하는 것이 좋습니다. 그래야 이 변수나 함수가 뜻하는 것이 어떤것인지 금방 파학할 수 있고 그것이 바로 읽기좋은 코드를 작성하는 가장 좋은 방법이기 때문이죠.

 

 코드를 작성하는데 어떤방법이 가장 좋다. 는 없습니다. 하지만 분명한건 읽기에 편한 코드가 좋은 코드라는 것입니다.