Python dict() 안에 여러 줄 주석을 넣는 방법

Python에서 딕셔너리(dict)를 정의할 때 주석을 추가하고 싶은 경우가 종종 있습니다. 결론부터 말하면, 일반적인 Python 스크립트처럼 어디든 주석을 넣을 수 있지만 한 가지 중요한 제약이 있습니다.

dict 안에서 사용 가능한 주석: 한 줄 주석(#)

딕셔너리 정의 내부에는 # 기호를 사용한 한 줄 주석만 넣을 수 있습니다. 예를 들어 아래 코드는 완전히 유효합니다.

예제 1: 올바른 선언

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

위 코드에서 두 번째 항목은 주석 처리되어 있지만, 딕셔너리 생성에는 전혀 문제가 없습니다. 이렇게 특정 키-값 쌍을 임시로 비활성화할 때 유용하게 활용할 수 있습니다.

여러 줄 주석(""" 문자열)은 사용할 수 없습니다

Python에는 별도의 여러 줄 주석 문법이 없으며, 흔히 여러 줄 주석처럼 사용되는 삼중 따옴표("""...""")는 사실 문자열 리터럴입니다. 문자열을 딕셔너리 정의 사이에 그냥 넣을 수는 없기 때문에, 다음과 같은 코드는 문법 오류(SyntaxError)가 발생합니다.

예제 2: 잘못된 선언

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

이 코드를 실행하면 Python 인터프리터가 문자열을 유효한 딕셔너리 요소로 해석하지 못해 에러를 냅니다.

정리 및 대안

• dict 내부에는 # 한 줄 주석만 사용할 수 있습니다.
• 여러 줄에 걸쳐 설명이 필요하다면 각 줄마다 #를 붙여 작성하는 것이 안전합니다.
• 긴 설명이 필요한 경우, 딕셔너리 바깥쪽(위쪽)에 여러 줄 주석 형태의 docstring을 배치하는 방법도 좋습니다.

요약하면, 딕셔너리 안에서 주석이 필요하다면 반드시 #를 사용한 한 줄 주석으로 작성해야 하며, 삼중 따옴표 문자열은 dict 정의 내부에서 사용할 수 없다는 점을 기억하시기 바랍니다.