Kant's Game Programming

주석

• 사전적 의미 : 낱말이나 문장의 뜻을 쉽게 풀이
  간단히 말해 코멘트 혹은 설명
• 흔히 말하는 좋은 프로그램의 조건인 유연성/가독성/일관성 등을 예를 드는데
  보기 쉽다는 말은 "가독성" 부분에 해당하는 중욯한 조건
• 내가 짠 소스에 달아 놓은 설명이 아니라 내가 앞으로 짤 소스에 다는 이정표
  즉, 프로그램을 짜기전에 설계를 해두고 설계대로 할 수 있도록 해주는 이정표
• 주석에 작성된 코드는 컴파일 시 컴파일러가 무시하고 빌딩을 진행
  
• 주의사항 : 남발 시에 가독성이 떨어지는 요소가 될 수 있다
  
  

종류

• 한줄 주석 : //
  말 그대로 한줄만 주석으로 처리하는 것
  // 이런식으로 사용
  // 두줄 처리시 두개를 사용
• // 두줄만 쓰고 필요한 내용을 적는 것 
  => 일반적으로 초록색으로 처리
  ///        // 이 것이 2개 이상이면 상관 없다.
  //////////// 
  /////////////////////////////////////////
  //< 
  //<(*#@&^$(*&#
  // 무조건 시작만 //으로 한다면 한줄 주석 예시
  
  
  
• 다줄 주석 : /* */
  /* : 다줄 주석의 시작
  */ : 다줄 주석의 끝
  /* 
      다줄 주석
      한번에 여러개 처리가능
      // 중간에 한줄주석 가능
  */
• 다줄 주석 안에서 다줄 주석 사용시 에러
  /* 내용/내용
   /* 다줄주석 또 사용시 마지막 */ 
  인식하지 못해 에러 발생
  */
  
  

주석의 활용

• 주석의 활용 방법 4가지
  함수를 제작 시
  변수를 선언 시
  제작자의 의도를 알려줄 때
  프로그램의 사용법을 알려줄 때
  
• 프로그램을 만들 때 보통은 어떤 식으로 진행할지 순서를 정하고 처리하는 것
  그래서 설계를 하는 이유이기도 합니다. 하지만, 프로그램을 작성하면서 지속적으로 노트를 보고 만들진 않습니다.
• 위와 같은 경우에 주석을 활용하게 됩니다. 
  
• 예제
  /* 이 프로그램은 정수 한개를 입력 받아 그 정수만큼 이름을 출력하는 프로그램 */
  #include <stdio.h>
  
  void main(void)
  {
      //< 입력 받을 정수 변수 선언
      //< 반복초기 변수 선언
      //< 정수입력 안내문
      //< 정수입력
      //< 반복문을 입력받은 정수 까지 반복
      //< 이름을 출력 
  } 
  위와 같이 1차 구성 후 아래의 프로그램을 작성하게 됩니다.
  #include <stdio.h>
  
  void main(void)
  {
      //< 입력 받을 정수 변수 선언
      int input;
      //< 반복초기 변수 선언
      int i;
      //< 정수입력 안내문
      printf("정수입력:");
      //< 정수입력
      scanf("%d",&input);
      //< 반복문을 입력받은 정수 까지 반복
      for(i=0; i<input; i++)
      {
          //< 이름을 출력 
          printf("홍길동!@#@\n");
      }
  }
  

결론 

가독성과 일관성이 좋은 코드를 위해 주석을 사용합니다.
미리 이런 습관을 가지는 것이 좋습니다.