주석은 프로그램을 이해하기 쉽도록 코드 내에 남기는 문장입니다. 하지만 주석은 프로그램이 실행되는 데에는 전혀 영향을 미치지 않습니다. 즉, 주석이 아무리 많아도 컴파일에는 특별한 영향을 미치지 않습니다. 그래서 주석을 이용해서 프로그래머가 프로그램에 대한 설명을 남기기도 하고, 작성한 날짜, 작성자, 개발 환경 등 많은 것을 남길 수 있습니다. 주석은 프로그래머들을 위한 요소입니다. 프로그래머들에게는 없어서는 안될 소금과 같은 것입니다.
|
▣ 주석의 특징 |
|
q 주석은 프로그램에 아무런 영향을 끼치지 않는다. q 프로그램의 설명을 붙이는 방법 |
머리가 좋아서 아주 긴 소스들을 다 이해하고 기억할 수 있다면 필요 없을 수도 있습니다. 하지만 주석을 소홀히 할 경우 대부분은 자기가 작성한 프로그램을 시간이 지나서 다시 보게 되면 이리저리 헤매는 웃지 못할 경우가 많이 발생합니다. 또한 그 소스를 다른 프로그래머가 보게 될 경우에도 프로그램을 이해하는데 시간이 엄청 걸리게 됩니다. 그렇다면 주석은 보기 좋게 충분히 달아 두어야 겠죠!
주석의 종류는 두 가지가 있습니다. 한 줄 주석과 여러 줄 주석입니다. 한 줄 주석은 ‘//’기호를 사용하죠. 이 기호가 나온 다음부터 그 줄 끝까지 주석 처리가 됩니다. 여러 줄 주석은 쌍으로 된 기호를 사용합니다. 시작 할 때는 ‘/*’ 기호를 사용하고, 마칠 때에는 ‘*/’ 기호를 사용합니다. 이 두 기호 사이는 전부 주석 처리가 됩니다. 그리고 여러 줄 기호내부에 한 줄 주석이 사용되어도 상관 없습니다. 하지만 여러 줄 주석 내부에 다시 여러 줄 주석을 사용하면 에러가 발생할 수 있습니다. 즉 여러 줄 주석은 /*로 시작하면 반드시 */로 닫아 주어야 합니다.
|
▣ 주석의 종류 |
|
q 한줄 주석 n // à 라인의 맨 앞에 표시되 그 줄 전체를 주석화함 q 여러줄 주석 n /* ~ */ à 라인의 수에 상관없이 /* 과 */ 사이 전체를 주석화 q 여러줄 주석 내에 여러줄 주석 사용불가 |
예제를 통해서 주석을 사용해 보겠습니다. 앞에서 다룬 HelloWorld 예제에 한 줄 주석과 여러 줄 주석을 추가한 예입니다.
|
& |
NoteTest.cs |
Ü 주석의 사용을 보여주는 예제 |
|
using System; /* 이 프로그램은 C#의 가장 간단한 구문과 함께 주석의 사용을 보여주는 예제로, 실행하면 "HelloWorld"라는 문자열을 도스 콘솔창에 출력합니다. */ class NoteTest { public static void Main() { // 다음은 콘솔에 문자열을 출력하는 부분입니다. Console.WriteLine("HelloWorld!"); } } | ||
|
C:\C#Example\01>csc NoteTest.cs C:\C#Example\01>NoteTest HelloWorld! | ||
예제의 소스코드를 보시면 프로그램의 내용을 설명하는 여러 줄 주석과 출력을 설명하는 한 줄 주석 부분을 볼 수 있습니다. 그리고 실행 결과는 앞의 HelloWorld의 예제와 다를 것 없어 주석이 프로그램 자체에 영향을 미치지 않는다는 것을 증명하고 있습니다. 주석은 아무리 많이 쓰여도 프로그램에 영향을 끼치지 않으므로 충분한 주석을 달아 두시는 습관을 들여 두시기 바랍니다.
참고로 C#에서는 코드 내에 /// 주석을 지원합니다. 슬래시 3개가 붙은 부분은 XML형태의 문서로 재작성 될 수 있고 XML 형태의 주석 문서는 다시 Html 문서로도 변환이 가능합니다. 즉, API Document를 만드는 방법이라고 생각하셔도 됩니다. 이것은 앞으로 나올 장들에서 배우게 될 것입니다.
| jabook저자명함 |
|
제목:소설같은C# 제1강의 저자:최영관 |
