[파이썬] 각종 주석을 달아봅시다 (한줄, 여러줄)

코드를 짜다보면 설명이 필요한 순간이 있습니다. 그것도 생각보다 많이 말이죠. 예를 들면,,

 

- 다른 사람과 프로젝트 협업 할 때 : 사람마다 화법이 조금씩 다르듯이 프로그래밍 하는 스타일도 다릅니다. 그렇기 때문에 일일이 남의 코드를 보며 번역하기엔 시간도 너무 오래걸리고 그에 따른 스트레스도 많이 받습니다. 이럴 때 코드에 주석이 있으면 이해를 도와 비교적 원활하게 협업이 가능합니다. 

(물론, 실제 현업 SW는 훨씬 복잡한 경우가 많으므로 주석만으론 안되고 두꺼운 양의 SW사양서가 함께 따라다닙니다.)

 

- 내가 쓴 코드를 나중의 내가 볼 때 : 개인 프로젝트에선 이 이유가 더 클 것 같습니다. 학생이든 직장인이든 매일 자신의 코드를 붙들고 있긴 생각보다 어렵습니다. 본업에서 바쁜일이 생기면 프로젝트엔 상대적으로 소홀해질 수 있기 때문입니다. 그러고 나중에 코드를 봤을 때 기억이 잘 난다면 다행이지만, ' 이걸 당시에 왜 이렇게 했지...? ' 하는 부분도 분명히 생기게 마련입니다. 그런 부분을 만났을 때 주석을 달면 프로젝트 진행에 무리가 없겠죠.

 

이제 파이썬에서 주석을 다는법을 알아봅시다. 사용한 환경은 아래와 같습니다.

- 파이썬 버전 : 3.9.6 64bit

- 텍스트 편집기 : 비주얼 스튜디오 코드 (Visual Studio Code; VS Code)

 

주석의 기본은,

 

1. 1줄짜리 주석 달기:

# 쓰고 싶은 문장 으로 주석처리가 가능합니다.  각 라인위에서 처리해도 되고 각 라인의 끝에 처리해도 됩니다.

 

2. 여러줄 주석 달기:

""" 주석내용 """ or ''' 주석내용 ''' 입니다. """ (''') 주석 내용에 엔터를 쳐서 여러줄을 만들면 됩니다. 

여러줄 주석은 함수를 설명할 때 더 유용합니다. (VS Code 기준)

 

아래와 같은 코드처럼 함수에 주석을 달았을 경우 함수에 커서를 올려놓으면 해당 주석을 볼 수 있습니다.

주석표시는 처음 달았던 주석만 표시되고 두번째 주석부턴 표시가 되지 않으니 참고하세요.

 

from add_notes import minus

a = 1 # 첫번째 변수 선언
# 두번째 변수 선언
b = 1

'''
여러줄 주석을 달아봅시다
a+b 를 프린트 합니다.
'''

print(f"a+b 는 {a+b}")

c = minus(a,b)
print(f"a-b 는 {c}")

def minus(c,d):
    """
    여러줄 주석은 함수를 설명할 때 유용합니다. \n
    이 함수를 사용하는 곳에서 마우스 커서를 올리면 해당함수에 대해 설명해줍니다. \n
    주석엔 엔터로 구분하지만 실제 설명칸은 엔터처리가 안되어 있으니 이스케이프 문자를 활용합시다 . \n
    이 함수는 인자 c, d를 받아서 c-d 값을 계산하여 반환합니다. \n
    문장 끝에 이스케이프 문자를 넣고 '---' (3개 이상) 를 아래에 붙이면 구분선이 됩니다. \n
    ---
    강조표시는 이스케이프 문자 없이 '---' (3개이상) 을 아래에 붙입니다. 
    ---
    - 앞에 '-' 를 붙여 글머리를 만들 수 있습니다. \n
    \t - 이스케이프 탭키를 넣어서 글머리 기호를 구분할 수 있습니다.
    \t - c : 인자 1
    \t - d : 인자 2 \n
    ---
    코드를 활용하여 설명하고 싶다면 >>>를 사용하여 아래처럼 할 수 있습니다. \n
    ---
        >>> minus(c,d)
                return c-d # 바로 c-d 를 반환합니다. 주석안에 주석처리도 가능합니다.    
    """

    """
    첫번째 주석만 표시됩니다.
    """

    return c-d

 

이 코드를 VS Code 에서 실행시키고 c=minus(a,b) 라인의 minus 쪽에 커서를 올려보면 아래 그림과 같은 설명이 나옵니다.

 

코드를 VS Code 에서 볼 때 1

 

코드를 VS Code 에서 볼 때 2

 

 

 

주석을 잘 활용하셔서 개발에 도움이 되길 바랍니다.

궁금한 사항 있으시면 댓글 부탁드립니다.