'c언어'에 해당되는 글 1건

  1. 2009.04.21 [scrap] 초보자들이 지켜야할 C언어 코딩기법
Information Security2009.04.21 17:12
 
먼저 이 글을 읽고 숙지하기에 앞서 이 글은
순전히 C언어 프로그래밍 초보자들을 위한 코딩 기법을 설명한 것임을
알려드립니다. 자신이 초보자가 아니면 그냥 넘어가시면 되겠습니다.
그러나 제가 만나 본 대부분의 프로그래머들(중수 이상 역시 포함)은
이런 규칙을 전혀 지키지 않고 코딩하더군요..
제가 쓴 글을 읽고 코딩한다면 누가 보더라도 정갈하고 깔끔한
코드가 될 것입니다. 나중에 스스로 짠 코드가 뭔 소린지 몰라
한참을 헤메지 않도록 열심히 노력합시다.
그럼 본론으로 들어갑니다..


1. 변수의 이름

보통의 경우 변수의 이름은 아무 뜻도 없거나 무진장 줄여 자신이 짠
코드도 나중에 보면 무슨 소린지 무슨 내용인지 전혀 알아 보지 못하는
경우가 있습니다. 이럴 때 변수의 이름만이라도 변수의 용도에 맞춰서
쓴다면 그 얼마나 좋겠습니까..

변수의 이름을 정할 때는 반드시 헝가리안 표기법을 사용합니다.

코드:
int nCounter=0;

이런식으로 변수의 이름 앞에 변수의 종류를 쓰는 것입니다.

보통 숫자는 number의 앞 글자인 n, boolean 변수는 b, 포인터 변수는 ptr,
문자형 변수는 c, 문자열 변수는 str 등 변수의 이름 앞에 특징을 기술하는 것입니다.

아래의 예를 보시기 바랍니다.
코드:
nSum=0;
nGrandTotal=0;
cAlphabet=NULL;
strSum[6]={0,};
ptrNextChain=NULL;

sum=0;
grandTotal=0;
alphabet=NULL;
sum[6]={0,};
nextChain=NULL;

위와 아래는 보기에도 차이가 납니다.
특히 alphabet 변수와 nextChain 변수는 아래의 예만 봤을 때 무슨
변수인지 전혀 알아 볼 수 없습니다. 그러나 위의 예를 보게 되면
최소한 알파벳 변수가 문자형 변수이고 넥스트체인 변수가 포인터라는
것은 변수의 이름을 통해 유추할 수 있습니다.

2. 변수의 초기화
변수의 초기화는 대단히 중요하면서도 간과하기 쉬운 예입니다.
변수는 로컬 변수, 글로벌 변수를 불문하고 무조건 변수 선언할 때
초기화
를 해줍니다. 보통의 C 컴파일러는 변수를 초기화하지 않고
그냥 사용하는 경우(즉, 초기화 없이 변수의 값을 읽는 경우) 워닝
메시지를 뿌리거나 메시지 없이 계속 컴파일합니다. 이것으로 생기는
side-effect(부작용)은 컴파일러도 책임지지 않습니다.
프로그램 코드가 길어지면 길어질수록 이런 변수 초기화를 하지 않아
생기는 문제는 더더욱 찾기 어려워집니다.

3. 변수의 용도 또는 사용 목적 기술
보통 위의 방법을 지켜 선언하더라도 변수를 선언할 때는 아래와 같이 하는
프로그래머들이 종종 있습니다.
코드:
int nCounter=0, nSum=0, nMaxBound=0;

나중에 코드를 읽는데 보기에 대단히 좋지 않은 방법입니다.
헝가리안 표기법으로 변수의 이름을 설정했지만 사실상 대략적인
의미만 파악할 수 있을 뿐 그 정확한 용도를 알아보기 힘듭니다.
따라서 아래와 같이 코딩합니다.
코드:
int nCounter=0; /* for문의 카운터로 사용하기 위해 선언 */
int nSum=0;     /* 성적의 합을 저장하기 위해 선언*/
int nMaxBound=0;   /* 그래프의 최대 한계값을 저장하기 위해 선언 */

자, 어떻습니까? 변수를 여러줄에 나눠서 선언한다고 해서 컴파일
시간이 비약적으로 늘어나는 것도 아니고 주석을 많이 단다고 해서
지저분한 프로그램 코드가 되는 것도 아닙니다. 위와 같이 코드를
짜놓으니 변수만 보고서도 무엇하는 프로그램인지 대충의 감을 잡게 됩니다.
프로그램 코드의 분석은 변수의 용도를 파악하기만 해도 절반은 된 것입니다.

잔소리. 저는 최대한 표준 C언어에 가깝게 코딩합니다. 보통의
컴파일러는 표준을 어기더라도 약간 느슨하게 허용하는 경우가 있으나
컴파일러간의 이식률을 높이기 위해 반드시 표준을 지켜서 코딩합시다.

4. 줄 맞추기
이건 잔소리 안할래야 안할 수 없습니다. 제가 대학시절 수업을
들을 당시 C언어를 강의한다는 강사라는 사람도 줄맞추기를
대충하더군요.. 줄맞추기는 칼 같이 해야합니다. 이건 권고사항이
아니라 반드시 지켜야할 강제사항입니다. 줄 맞추기 위해서
스페이스를 두 번 뚜드리던 탭을 한번 하던 그것은 여러분들의
자유지만 어떤 방법을 쓰더라도 줄 맞추기는 통일성 있게
칼 같이 해줘야 합니다. 어떨 때는 스페이스 2번으로 했다가
어떨 때는 탭으로 했다가 하는 짓은 줄 맞추기를 아니한만 못합니다.
코드를 분석해야하는 사람의 입장에서는 굉장히 괴로운 일입니다.
결국에는 눈물을 머금고 코드 줄 맞추기를 한 뒤에 그제서야
코드를 읽기 시작합니다. 무심코 빼먹은 줄 맞추기가 여러 사람 괴롭힙니다.

5. 중괄호 쓰기
코드를 아름답게 하는 방법중에는 중괄호를 많이 쓰는 방법도 있습니다.
중괄호를 많이 쓰면 그만큼 코드를 읽기 편해집니다. 영역이 명시적으로
표시되기 때문이지요.. 예를 볼까요?
코드:
while(i>0) if(i>0) printf("안녕?"); else i--;

while(nCounter>0)
{
  if(nCounter>0)
  {
    printf("안녕?");
  }
  else
  {
    nCounter--;
  }
}

극단적인 예이기는 하지만 저런 식으로 코딩하는 양반들도
종종 있습니다. 프로그래머라고 할 수도 없는 사람들이지만 말입니다.
아래의 예를 보면 어디서부터 어디까지 무슨 기능을 하는지 명시적으로
표현되어 있습니다. 단 한줄의 코드라도 for, do ~ while, switch ~ case, if ~ else 등
중괄호를 사용할 수 있으면 하라는 것입니다.
사실 중괄호는 아무데나 사용할 수 있습니다만 보통은 변수의 범위를
적절하게 설정하기 위해 코드 중간에 다음과 같이 사용하기도 합니다.
코드:
...
  {
    int nCounter=0;
    for(nCounter=10; nCounter > 0; nCounter--)
    {
      ...
    }
  }
...


6. Comment(주석)의 사용
누가 Comment를 주석이라고 이름 붙였는지 모르지만 주석이라는
단어의 사전적인 의미를 모르겠군요.. 그냥 주석은 이런저런 것이다는
것을 경험에 비추어 알고 있지만 말입니다. (일본식 단어인 것 같은
느낌을 팍팍 주는군요..) 저는 코멘트라고 하겠습니다.

용어야 어쨌거나 말았거나 코멘트는 많으면 많을 수록 좋다는 것이
제 지론입니다. 코멘트가 많으면 일단 프로그램을 읽는데 훨씬 수월해집니다.
긴 말 필요 없이 예를 보도록 하겠습니다. 아주 나쁜 예입니다.
코드:
int main(void)
{
  int n,m,i,j,x,y,z,dae,so;

  while(1)
  {
    printf("두수를 입력하시오 : ");
    scanf("%d,%d",&n,&m);

    if(n==0 || m==0)
    {
      break;
    }

    x=n;
    y=m;

    for(;;)
    {
      z=x%y;
      if(z==0)
      {
        break;
      }
      else
      {
        x=y,y=z;
      }
    }
    so=y;

    printf("%d\t,",so);

    dae=n*m/so;

    printf("%d\n",dae);
  }
  return 0;
}

아.. 줄 맞춤은 제대로 되었지만 언뜻 봐서는 이거 뭐하는 프로그램인지
도무지 알 수가 없습니다.. 5초 안에 알아보실 수 있겠습니까?
변수 이름도 엉망진창이고 주석도 하나 없고 도무지 알아 먹을 수 있는
코드가 아닙니다. 만약 이 코드를 5초안에 알아 볼 수 있다면
이 프로그램을 1시간 전에 짰거나 이 알고리즘을 자다 일어나서도 외울 수
있을 정도인 사람이거나 당신은 정말 코드 분석의 천재입니다.
훌륭한 예를 보겠습니다.
코드:
/*************************************************************
Promgrammed by Chronoshift at 2003.10.12
If you want to contact me, send email to taktaktak@aheheh.com
 
아규먼트
  없음

부작용
  없음

프로그램의 내용
  두 수를 입력 받고 입력 받은 두 수를 가지고
  먼저 최대공약수를 계산하고 최대공약수와
  입력받은 두 수를 가지고 최소공배수를 계산한다.
*************************************************************/

int main(void)
{
  int nInputNumber1  = 0;  /* 입력 받은 숫자를 저장하는 변수 */
  int nInputNumber2  = 0;  /* 입력 받은 숫자를 저장하는 변수 */
  int nNumberBuffer1 = 0;  /* 공약수 계산을 위한 임시 저장소 */
  int nNumberBuffer2 = 0;  /* 공약수 계산을 위한 임시 저장소 */
  int nBalance       = 0;  /* 나머지 값을 저장 */
  int nGCM           = 0;  /* 최대공약수 */
  int nLCM           = 0;  /* 최소공배수 */

  while(1)
  {
    /* 수를 입력 받는 부분 */
    printf("두 수를 입력하시오 <예) 43 22> : ");
    scanf("%d,%d",&nInputNumber1,&nInputNumber2);

    /* 입력이 잘 못 된 경우 */
    if(nInputNumber1==0 || nInputNumber2==0)
    {
      printf("This program not support 0 to input.\r\nPlease input other number again.");
      break;
    }

    /* 입력 받은 수를 최대공약수 계산을 위해 임시 저장 */
    nNumberBuffer1 = nInputNumber1;
    nNumberBuffer2 = nInputNumber2;

    /* 최대 공약수 계산 부분 */
    /* 최대 공약수를 구하는 알고리즘은(X/Y)%Z == 0 일때까지 무한 반복 */
    /* 만약 X=69 이고 Y=93이면 나머지 69가 된다 */
    /*  X  Y  Z       */
    /* 69 93 69       */
    /*   ↙ ↙        */
    /* 93 69 24       */
    /*   ↙ ↙        */
    /* 69 24 21       */
    /*   ↙ ↙        */
    /* 24 21 3        */
    /*   ↙ ↙        */
    /* 21 3 0         */
    /*   ↙           */
    /* 최대공약수 : 3 */

    for(;;)
    {
      /* 두 수를 나눈 나머지 계산*/
      nBalance = nNumberBuffer1 % nNumberBuffer2;
     
      /* 나머지가 0이면 GCM을 찾은 것이다 */
      if(nBalance == 0)
      {
        break;
      }
      /* 그렇지 않으면 알고리즘에 의해 Y를 X에 넣고 */
      /* 나머지를 Y에 넣고 재계산한다 */
      else
      {
        nNumberBuffer1 = nNumberBuffer2;
        nNumberBuffer2 = nBalance;
      }
    }
    nGCM = nNumberBuffer2;
   
    /* 최소공배수는 두 수를 곱하고 최대공약수로 나누면 된다 */
    nLCM = nInputNumber1 * nInputNumber2 / nGCM;

    printf("%d\t%d\r\n", nGCM, nLCM);
  }
  return 0;
}


얼마나 아름다운 코드입니까.. 코드를 모두 제거하고
주석만 남기더라도 뭐하는 프로그램인지, 어떻게 돌아가는지,
어떻게 코드를 짜야하는지 금방 알 수 있습니다.
이것이 바로 아름다운 1줄의 예술이라는 것입니다.
7. 맺음말..
더 이상 할 말이 없습니다. 앞에서 얘기한 6가지 원칙을 지키면
누구라도 한 줄의 예술을 할 수 있는 것입니다. 거만하게도 여러분들이
저를 보시기에 제가 고수라고 느끼실런지 몰라도 저 역시 하수일 뿐입니다.
진정한 고수라고 생각되는 사람이 저희 회사에 한 명이 있는데
그 양반 코드는 아주 소설입니다. 프로그래밍을 할 때 아주 소설책을 씁니다.
줄줄이 소설을 쓴 뒤에는 그 소설을 코멘트로 해서 코드를 써갑니다.
코드를 작성한다기 보다 쓴다고 해야 옳은 표현일겁니다.
물론 프로그래밍 마인드가 있어야 가능한 일이기는 합니다.
어쨌거나 코멘트를 바탕으로 코드를 작성해야 하는 원칙은 어느 언어든지
틀린 이야기가 아닙니다. 어렸을 때 전산학원을 다닌 사람들은 알 겁니다.
프로그램 언어를 배우기 전에 순서도를 배우죠. 그리고 순서도를 먼저
그리고 그것으로 프로그래밍하라고 배우죠. 사실은 순서도를 코멘트로
변환하고 그것으로 코딩해야 하지만 말입니다..
에이 모르겠다.. 역시 저는 글쟁이는 안되나 봅니다.
찝찝하더라도 여기서 끝입니다. -끝-

출처 : TFH-Chronoshift


 

'Information Security' 카테고리의 다른 글

[scrap] 초보자들이 지켜야할 C언어 코딩기법  (0) 2009.04.21
Base64 인코딩 표  (0) 2009.03.22
아스키코드표  (0) 2009.03.22
Posted by 퍼덕퍼덕