Python 딕셔너리(Dictionary)에 주석을 추가하는 방법

파이썬(Python)에서는 일반적인 방식대로 스크립트 어디에든 주석을 작성할 수 있습니다. 다만, 딕셔너리 내부에는 # 기호를 사용한 한 줄 주석(single-line comment)만 넣을 수 있다는 점에 유의해야 합니다.

딕셔너리 안에서 주석이 동작하는 방식

여러 줄 주석(트리플 따옴표 문자열)은 파이썬에서 하나의 문자열 표현식으로 취급되기 때문에, 딕셔너리 정의 중간에 단순히 문자열만 삽입하는 것은 허용되지 않습니다.

유효한 예시: 한 줄 주석 사용

다음과 같이 #로 작성된 한 줄 주석은 문제없이 정상적으로 동작합니다:

testItems = {
    'TestOne': 'Hello',
    # 'TestTwo': None,
}

잘못된 예시: 여러 줄 주석 사용

반면, 아래와 같이 트리플 따옴표(""")로 감싼 여러 줄 주석을 딕셔너리 내부에 넣으면 SyntaxError가 발생합니다:

testItems = {
    'TestOne': 'Hello',
    """
    Some random
    multiline comment
    """
}

정리

• 딕셔너리 내부에는 # 한 줄 주석만 사용할 수 있습니다.
• 여러 줄 주석은 문자열로 해석되므로 딕셔너리 정의 사이에 넣을 수 없습니다.
• 긴 설명이 필요하다면 딕셔너리 바깥쪽에 여러 줄 주석을 작성하는 것이 좋습니다.