[프로그래밍] 2.8 주석(Comment)

※이 글은 프로그래밍 언어에 대한 기초적인 이해를 가정하고 있습니다. 최소 프로그래밍 언어 하나 정도를 약간이라도 접해보시는 것을 추천합니다. 또한, 이 글은 심화 내용은 되도록 피하여 서술했습니다.

 

이번 글에서는 주석(Comment)가 각 언어에서 어떻게 표현되어 이용되는지 소개합니다.

 

C,C++의 주석은 다음과 같이 //와 /* */을 이용하는 방법이 있으며, 후자는 여러 줄의 주석을 삽입할 때 이용합니다.

 

//주석입니다. 여기 내용은 프로그램에 포함되지 않습니다.
/* 그렇다고 아무말이나 쓰면 나중에 코드 분석할 때 힘들겠죠? 
코드를 부가 설명해 나중에 편집 시 편의성을 높일 수 있습니다*/

 

Java의 주석은 다음과 같이 사용됩니다.

//주석입니다. 여기 내용은 프로그램에 포함되지 않습니다.
/* 그렇다고 아무말이나 쓰면 나중에 코드 분석할 때 힘들겠죠? 
코드를 부가 설명해 나중에 편집 시 편의성을 높일 수 있습니다*/
/**이렇게 해둔 주석은
앞 주석과 약간 차이가 있습니다*/

/** **/형태의 주석은 앞의 두 주석과 다르게 클래스나 메소드의 설명을 붙여서 나중에 tooltip형태로 표시할 수 있다는 특징이 있습니다. 이는 Javadoc Tool에 의해 해석될 수 있어 일정한 포맷으로 작성하면, 이를 나중에 Javadoc Tool이 읽어 Tooltip을 표시할 수 있습니다. 아래 예시를 참고해봅시다.

/**
 * This is awesome method
 * Returns an String object
 */
public String getString(String input){
	return input;
}

 나중에 이 메소드를 사용하게 되면, Eclipse기준으로 마우스 호버링을 해당 메소드 위에 올렸을 때 설명이 표시된다고 합니다. 자세한 사항은 공식 문서를 참고해보세요.  (https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html)

 

Python의 주석은 기본적으로 #입니다. (주석 또한, 시작 위치는 들여쓰기를 잘 맞춰야 합니다)

# TODO : Add Multi-language support

''' '''또는 """ """으로 여러 줄 주석을 달 수 있습니다. 이는 여러줄 문자열을 표시하는 사용하는 방법이기도 하지만, docstring이라고 하여 문서화를 하는 데에도 사용됩니다. 아래 예시를 참고해봅시다.

class sth():
    '''this is also a comment
	and this is awesome'''
    def something():
        '''this is also a comment
	and this is awesome'''
        pass

나중에 프로그램을 Python Shell창에서 실행시켰다고 합시다. 그러면 help함수를 통해 다음과 같은 결과를 얻을 수 있습니다.

Docstring의 진가가 발휘되는 순간

이렇게 하면 나중에 문서화하는데 편하겠죠?