[python] Class의 주석에 대해서 """ """

파이썬에서 클래스나 함수에 주석을 달 때는 보통 큰따옴표(""")를 사용하는 것이 일반적입니다.

이는 주석을 여러 줄로 작성할 수 있게 해주고, 클래스나 함수의 docstring(문서 문자열)으로 활용될 수 있습니다.

예를 들어, 클래스에 주석을 다는 방법은 다음과 같습니다:

class MyClass:
    """
    이 클래스는 예시 클래스입니다.
    여러 줄로 설명을 추가할 수 있습니다.
    """
    def __init__(self, name):
        self.name = name
    
    def greet(self):
        return f"Hello, {self.name}!"

 

 

 

이렇게 주석을 달면, 해당 클래스에 대한 설명을 제공할 수 있습니다. """로 시작하고 끝나는 부분이 바로 docstring입니다.

#을 사용할 수도 있지만 여러중에 해당할때는 가독성 문제도 있다.

class MyClass:
    # 이 클래스는 예시 클래스입니다.
    def __init__(self, name):
        self.name = name
    
    def greet(self):
        return f"Hello, {self.name}!"

 

무엇보다 """  """ 를통해서 입력된 설명은 문자열(docstring)을 출력가능하다
 python에서 __doc__ 속성을 사용하면된다.

이 속성은 클래스, 함수, 모듈 등의 docstring을 포함하는 문자열을 반환합니다.

따라서, 주어진 코드에서 클래스 MyClass의 docstring을 출력하려면 다음과 같이 할 수 있습니다:

class MyClass:
    """
    이 클래스는 예시 클래스입니다.
    여러 줄로 설명을 추가할 수 있습니다.
    """
    def __init__(self, name):
        self.name = name
    
    def greet(self):
        return f"Hello, {self.name}!"

# 클래스의 docstring 출력
print(MyClass.__doc__)