17. 주석(Comment)에 관하여.

프로그램 코딩을 할 경우 우리는 소스 중간 중간에 특별한 설명을 달아 놓을 필요가 있습니다.

이러한 설명을 주석(Comment)라고 합니다.

나중에 디버그(오류 수정)나 업데이트(기능 향상) 작업을 할 경우 혹은 다른 사람이 디버그나 업데이트 작업을 할 경우 참조하기 위해서 주석은 반드시 필요로 합니다.

또한 코딩 날자라든지 이후 업데이트한 내용 코딩한 사람에 관한 정보 등도 소스에 넣어 두면 추후 작업에 많은 도움을 줄 수 있습니다.

솔직히 저도 코딩한 후 한달이 지나 소스를 보면 이 구문은 왜 한거지? 이 변수는 뭤때문에 선언한 건지 헷갈릴 때가 많습니다.
그때 자세한 주석처리가 있으면 추후 작업이 아주 수월해 질 수가 있습니다.

이 주석은 소스에만 존재하며 실지 컴퓨터가 실행하는 실행파일에는 존재하지 않습니다.

C와 JAVA 는 // 와 /* .. */ 를 이용해서 주석문을 구분 시킵니다.

// 이것은 주석입니다. -> 한줄의 주석을 기록할 때 사용합니다.

/* 주석 시작
아날리스트 : 아코미스트
코더 : 홍길동
2025. 1. 13 : ...에 관해 오류 수정
2025. 3. 20 : ...에 관해 업데이트
주석 종료 */   -> 여러줄의 주석입니다.

Python 은 #을 이용해서 한줄의 주석문을 작성합니다. 여러줄인 경우 주석의 시작 과 종료 부분에 ### 를 사용합니다.

# 이것은 주석입니다.

### 주석 시작

아날리스트 : 아코미스트
코딩 : 홍길동
주석종료 ### 

 

Visual Basic 은 '(작은 따옴표)를 사용해서 주석문을 작성합니다.   주석이 여러줄인 경우에는 모든 줄 앞을 ' 로 시작하면 됩니다.

' 이것은 주석입니다.
' 아날리스트 : 아코미스트
' 코딩 : 홍길동

주석의 사용은 위와 같이 프로그램 소스에 관한 설명외에도 프로그램 개발 과정에서 다양한 목적으로 사용될 수도 있습니다.

만약 어떤 문제를 해결하는데 여러가지 방법이 있을 경우 각각의 방법을 코딩한 경우 사용할 부분만 남겨두고 나머지는 모두 주석처리해서 실행하지 않도록 할 수 있고, 이렇게 여러가지 방법을 번갈아 실행해 보면서 가장 적합한 방법을 선택할 수도 있습니다.

또한 오류를 잡아내기 위해서 특정 과정을 실행에서 잠시 제외 시켜 보거나 임시로 특정 처리를 첨가 시킨 후 오류가 해결된 경우 해당 부분을 주석 처리해 버릴 경우에도 유용하게 사용할 수 있습니다.

만약 현재까지 작업으로 소스 코딩을 완료하지 못하고 다음에 다시 진행할 경우 지금까지 한 내용과 다음에 계속할 내용을 말미에 주석으로 남겨두어 다음 작업을 수월하게 진행시킬 수 있습니다.

또한 특정 기능을 인터넷 사이트 등에서 참조한 경우에도 해당 사이트 주소를 기록하여 다음에 동일한 내용을 사용할 경우 해당 사이트에서 다시 정보를 자세히 알아볼 경우에도 사용할 수 있습니다.

저는 개인적으로 소스코드내에 주석이 상세하고 많이 적어놓는 프로그래머가 훌륭한 프로그래머라고 생각합니다.

요 약.
1. 주석은 프로그램 코드를 작성할 때 해당 코드에 관한 내용 혹은 의미 등 설명을 위해서 사용됩니다.
2. 주석은 소소내의 특정 부분을 실행과는 상관없이 단순 기록으로만 유지시켜 줍니다.
3. 주석은 프로그램의 유지 보수에 중요한 역활을 수행합니다.

 

다음은 조금 복잡한 개념이 될 수 있으나 아주 중요한 개념인 함수(Function)와 클라스(Class)에 관해 설명해 보겠습니다.

16. 코드블럭에 관하여