Python : Comment 사용 방법, 예제, 명령어

Python 코드를 작성할 때는 항상 코드를 깨끗하고 쉽게 이해할 수 있도록 만드는 것이 좋습니다. 코드를 구성하고 변수와 함수를 설명하는 이름을 지정하는 것이 이를 위한 여러 가지 방법입니다.

코드의 가독성을 향상시키는 또 다른 방법은 주석을 사용하는 것입니다. 주석은 코드를 설명하는 데 사용되는 사람이 읽을 수 있는 설명 또는 주석입니다. 예를 들어, 복합 정규식을 작성한 경우 코드가 수행하는 작업을 설명하는 주석을 추가합니다.

Python 코드에 주석을 추가하면 나중에 코드를 살펴볼 때 많은 시간과 노력을 절약할 수 있습니다. 당신이 몇 달 또는 몇 년 전에 쓴 대본을 바꾸고 싶다고 가정해 보겠습니다. 코멘트를 추가하지 않으면 복잡한 코드를 작성한 이유를 기억하지 못할 가능성이 있습니다. 또한 코멘트는 다른 개발자가 사용자의 코드와 코드 용도를 이해하는 데 도움이 됩니다.

 

 

Python : Comment 사용 방법, 예제, 명령어

 

 

Python으로 주석을 작성

Python은 해시 표시(#) 뒤에 줄에 기록된 모든 내용을 무시합니다.

설명은 줄의 시작 부분 또는 다른 코드로 인라인으로 추가할 수 있습니다.

# This is a Python comment.
print("Hello World") # This is an inline Python comment.

 

 

해시 표시 뒤의 공백은 필수는 아니지만 설명의 가독성을 향상시킵니다.

문자열 리터럴 내의 해시 문자는 주석 줄의 시작을 나타내지 않습니다. 이것은 단순히 해시 문자입니다.

paragraph = "# Hash inside quotes is not a comment."

Comments should be at the same indent level as the code beneath it:

```py
def factorial(n):
  if n == 0:
    return 1
  else:
    # Use the factorial function
    return n * factorial(n-1)

 

 

텍스트 편집기에서 구문 강조 표시를 지원하는 경우 주석은 일반적으로 녹색으로 표시됩니다.

주석은 스크립트를 디버깅할 때도 유용합니다. 일부 선 또는 블록을 삭제하는 대신 주석을 추가할 수 있습니다.

# for fruit in fruits:
#   print(fruit)

 

 

 

Python의 여러 줄 주석(Comment Blocks)

널리 사용되는 다른 프로그래밍 언어와 달리 파이썬은 한 줄의 주석만 지원합니다.

Python에서 여러 줄 주석을 작성하는 가장 간단한 방법은 한 줄씩 주석을 추가하는 것입니다.

# This is the first line.
# This is the second line.

 

 

또 다른 옵션은 docstring 을 사용하는 것입니다.

Docstring은 모듈, 함수, 클래스 또는 메서드가 수행하는 작업을 문서화하는 데 사용되는 다중 문자열 리터럴입니다.

문서 문자열은 세 개의 큰따옴표("")로 시작하고 끝나며 한 줄 또는 여러 줄에 걸쳐 있을 수 있습니다.

"""This is
a multiline
docstring.
"""

 

 

Docstring은 기술적으로 코멘트가 아닙니다. docstring이 모듈, 함수, 클래스 또는 메서드에서 첫 번째 문으로 발생하면 바이트코드로 끝나 해당 개체의 __doc__ 특수 특성이 됩니다. 일반적인 한 줄 해시 주석을 사용하는 것이 좋습니다.

 

 

 

셰방

Python 스크립트를 읽는 경우 첫 번째 줄은 #! 문자로 시작하고 Python 인터프리터 경로는 다음과 같습니다.

#!/usr/bin/env python3

 

 

이 문자 시퀀스를 shebang이라고 하며 파일의 나머지 부분을 구문 분석하는 데 사용할 인터프리터를 운영 체제에 알려주는 데 사용됩니다. shebang으로 시작하고 실행 가능한 스크립트는 스크립트 이름 앞에 python을 입력하지 않고 터미널에서 실행할 수 있습니다.

shebang 라인은 해시 문자로 시작하므로 주석으로 간주되어 파이썬 인터프리터에 의해 자동으로 무시됩니다.

 

 

 

결론

코멘트를 작성하는 것은 좋은 방법이며 미래의 자신을 포함한 다른 개발자가 코드가 무엇을 하는지 이해하는 데 도움이 됩니다. Python에서 해시 표시(#) 이후와 줄 끝까지의 모든 것은 주석으로 간주됩니다.