Python

[Python] - 파이썬 주석 (한줄, 여러줄, 단축키)

nam_ji 2024. 9. 2. 16:05

파이썬 주석 (한 줄 주석, 여러 줄 주석, 단축키)

한 줄 주석

  • 한 줄 주석은 코드 한줄에 주석을 달고 싶을 때 사용합니다. 한 줄 주석은 아래 코드와 같이 두 가지 형태로 사용이 가능합니다. 코드 한 줄을 전부 차지하도록 처음부터 #을 사용하여 주석처리하는 방법과 코드 뒤에 #을 사용하여 주석을 처리하는 방법입니다. # 이후 코드는 모든 주석처리 됩니다. 때문에 print(#코드)처럼 코드 안에 한줄 주석을 추가할 경우 오류가 발생할 수 있습니다.
    • # 파이썬
      python = '파이썬
      print(python) # 파이썬 출력
      print(#'파이썬')

여러 줄 주석

  • 어려 줄 주석을 한 번에 사용하고 싶을 때에는 큰따옴표 3개, 작은 따옴표 3개로 여러 줄 주석을 사용할 수 있습니다. 
  • 여기서 주의할 점은 큰 따옴표를 시작하면 큰 따옴표로, 작은 따옴표로 시작하면 작은 따옴표로 끝나야 합니다.
    • """
      파이썬 어려 줄 주석입니다.
      큰 따옴표 세개를 이어 붙이면
      자동으로 주석 공간이 생깁니다.
      """
      
      '''
      작은 따옴표 3개를 이용한
      여러 줄 주석입니다.
      작은 따옴표 3개를 입력하면
      자동으로 주석 공간이 생깁니다.
      '''

주의점

  • 파이썬을 사용하다 보면 아래와 같이 if, for, def, class를 사용할 때 들여쓰기를 사용하게 됩니다. 이때 아래처럼 ''',"""를 들여쓰기 하지 않으면 오류가 발생합니다. 때문에 주석 또한 들여쓰기에 신경써서 사용해야 합니다.
    • if a == b:
      '''
      이렇게 작성하면 에러 발생입니다.
      '''
      	print('')
          
      if a == b:
      	'''
      	이렇게 작성해야 합니다.
      	'''
      	print('')

단축키

  • 파이참과 VSCode(Visual Studio Code)의 단축키는 window 환경에서 Ctrl + / 입니다.
  • 또한 원하는 부분을 드래그 해두고 단축키를 누르면 전체 주석이 됩니다.
  • 다만 따옴표를 이용한 주석이 아닌 #을 이용한 한 줄 주석으로 적용됩니다.