Code Comments

코드를 쓰다보면,어떤 글자나 단어들은 특별한 뜻이 있다는 것을 눈치 챘을거에요.예를 들어,당신은 C#에서 다양한 키워드들을 볼 수 있어요.예를 들자면class, namespace, public 등등이 있죠.또한 컴파일러가 키워드,메소드,변수들을 당신이 올바르게 썼는지 확인한다는 것을 알 수 있죠.C#은 상당히 엄격한 언어에요.그리고 컴파일러가 당신이 모든것들을 올바르게 썼는지 도와주죠.어쨌든.당신은 주석덕분에 당신이 쓰고싶은대로 쓸 수 있어요.

당신이 본 코드에서 이미 주석을 봤을 수도 있어요.C#이나 다른 언어에서도요.코드에서 코멘트의 개념은 상당히 유용해요.주석이 쓰이는 방법은 상당히 다양하죠.당신이 C#코드에서 쓸 수 있는 주석의 종류들을 한번 볼까요?

한줄 주석

C#에서 가장 흔한 종류의 주석은 한줄 주석이에요.이름에서 알 수 있듯이,이것은 한 줄을 주석으로 바꿔줘요.이것이 어떻게 보이는지 한번 보죠.

// My comments about the class name could go here...
class Program
{
    ......

줄 앞에 슬래쉬 두개를 붙이세요(//)그러면 당신의 텍스트는 컴파일러가 오류가 있다고 불평하는 것에서,그냥 컴파일러가 이 줄을 무시하는 것으로 바뀌는 거에요.이 현상은 앞에 슬래쉬가 붙여져 있는 줄에서만 일어나요.당신은 이 행동을 다음줄에서 똑같이 해도 되요.근본적으로 보자면 한줄 주석으로 여러줄 주석을 만드는 것이죠.

// My comments about the class name could go here...
// Add as many lines as you would like
// ...Seriously!
class Program
{
    ...... 

여러줄 주석

당신이 여러줄의 주석을 쓰고 싶을때,C#이 제공하는 여러줄 주석 기능을 쓰는게 더 편할거에요.매 줄 앞에 붙이는 대신,당신은 글자의 시작과 끝에 쓰면 돼요.그 사이에 있는 모든 것들이 주석으로 인식되죠.

/*  
My comments about the class name could go here...  
Add as many lines of comments as you want  
    ...and use indentation, if you want to!  
*/  
class Program  
{
    ......

시작 지점에 슬래쉬-별(/*)을 쓰고,당신이 쓰고 싶은 내용을 쓴 다음에,한줄이든 여러줄이든,끝 지점에 별-슬래쉬(*/)를 쓰세요. 이 기호들 사이에,당신은 원하는 무엇이든 쓸 수 있어요.

다른 프로그래밍 주제들 처럼,한줄 주석을 쓰냐 아니면 여러줄 주석을 쓰냐는 종종 논쟁거리가 되고는 해요.개인적으로,저는 둘다 써요.상황에 맞춰서요. 결국에는,하고싶은 대로 하시면 됩니다!

문서 주석

문서 주석(XML 문서 주석이라고도 불려요)는 일반 주석같이 보이지만,XML이 포함되어 있어요.일반 주석처럼:얘는 한줄로 쓸 수도 있고 여러줄로 쓸 수도 있어요.그냥 똑같은 방법으로 하면 되는데,문자를 조금 더 쳐야 해요.한줄 XML 주석은 슬래쉬를 3번 쓰고(///),여러줄 주석은 별을 더 붙여요.어떻게 작동하는지 보죠.

class User
{
    /// <summary>
    /// The Name of the User.
    /// </summary>
    public string Name { get; set; }

    /**
    * <summary>The Age of the User.</summary>
    */
    public string Age { get; set; }
}

여기서 당신은 한줄과 여러줄 둘다 볼 수 있죠.결과는 같아요.그러나 한줄 주석 방식이 문서 주석을 쓸때 많이 쓰이는 방식이에요.

당신이 쓴 것을 문서화 시키고 문서 주석의 내용들은 좀 복잡한 주제에요.그러니 나중에 좀더 깊게 알아볼게요.지금 당신이 알면 되는 것은 어떻게 생겼는지 에요!

주석과 작업 리스트

당신이 비주얼 스튜디오를 쓰고 있다면,당신은 주석을 추적하는데 도움을 받을 수 있어요.작업 리스트 창에서(메뉴 -> 보기(View) > 작업 리스트(Task List))만약에 특별한 구문을 썼다면,당신의 주석이 나타날 거에요.

//TODO: Change "world" to "universe"
Console.WriteLine("Hello, world!");
//HACK: Don't try this at home....
int answerToLife = 42;

만약 한줄 코멘트에 TODO 나 HACK이 들어있다면,그것들은 비주얼 스튜디오의 작업 리스트에서 나타날 거에요.이렇게요:

그리고 여기에는 더 많은 종류들이 있어요.당신이 쓰고있는 비주얼 스튜디오 종류에 따라,비주얼 스튜디오는 아래 토큰들에 응답할거에요.

• TODO
• HACK
• NOTE
• UNDONE

당신은 당신만의 토큰을 추가할 수도 있어요.여기있는 글의 방법을 참고하세요.

요약

주석들은 당신의 코드를 문서화 할때나 당신을 위하여 설명을 써놓을떄,아니면 어떻게 작동하는지 알려주는 동료가 되는등 매우 유용합니다.그리고 추가로,당신이 무언가를 빠르게 시험해봐야 할때 줄을 복사해서 원래 글을 주석처리 해놓아 어떻게 되는지 볼 수 있죠.만약 당신이 결과에 만족하지 않았다면,그냥 새로쓴 줄을 삭제하고 주석처리를 풀어서 전 상태로 복구할 수 있어요.

그리고 최종 사용자가 주석을 통해서 코드를 엿보는 것은 걱정 안하셔도 되요.주석은 이미 말했지만,컴파일러에 의해 완전히 무시되기 때문에 당신의 최종 DLL파일이나 EXE파일에 포함되지 않아요.주석은 그저 프로그래밍 할때 당신의 개인적 자유로운 공간이라고 생각하면 돼요.그러니 쓰고싶은 대로 자유롭게 쓰세요.