주석을 보여주는 __doc__

__doc__

현재 자주 사용하는 VScode를 사용하기 전에 주로 쓰던 Jupyter 환경을 잘 안쓰게 되면서 아쉬웠던 것이, 단축키로써 함수나 class에 대해 tooltip을 편하게 조회할 수 있다는 것이었다. VScode에서도 커서를 올리면 확인이 가능하지만 그렇지 않을 때도 꽤 있어서 불편했다. 이럴 때 필요한 것이 바로 주석을 출력하는 것이고, Class나 method의 주석은 doc로 출력 가능하다

 

__doc__:
Python Object의 attribute중 하나로, init 함수 상단에 작성한 Class 에 대한 주석이나, 메소드 내에 작성한 주석을 반환한다

class Car:
    """ 이것은 Class Car에 대한 주석입니다 """
    # instance method
    def __init__(self, company, details):
        self._company = company
        self._details = details

                # instance method 내에서 class attribute 또한 다룰 수 있다
                Car.car_count += 1 

        # instance method
        def detail_info(self):
            """ 이것은 detail_info 메소드에 대한 주석입니다 """
            print(self._details)

print(car1.detail_info.__doc__) # instance method 주석 출력 : "이것은 detail_info 메소드에 대한 주석입니다"
print(Car.__doc__) # Class 주석 출력 : "이것은 Class Car에 대한 주석입니다"