독스트링
함수, 모듈, 클래스, 메소드에 대한 설명이 적힌 문자열.
관례상 모든 독스트링은 삼중 따옴표 """을 씀.
무엇을 하는지 간결하게 설명되어 있어야함.
독스트링을 사용하는 이유
개발자가 코드를 하나씩 해석하지 않아도 문서화를 통해 해당 코드가 어떤 코드인지 알 수 있다.
독스트링을 살펴보면서 코드에 대해 명확하게 이해하여 사용하기 이전에 버그 방지를 할 수 있다.
독스트링 살펴보기
독스트링이 작성된 객체에 __doc__ 속성을 호출하면 독스트링을 볼 수 있다.
print(len.__doc__)
Return the number of items in a container.len이라는 함수는 컨테이넌 안의 아이템 개수를 리턴한다라는 것을 쉽게 알 수 있다.
독스트링 작성하기
def plus(*args):
"""
int 타입의 인자들의 총 합을 리턴한다.
"""
result = 0
for a in args:
result += a
return result
print(plus(1,2,3,4,5,6,7,8,9)) # 45
print(plus.__doc__) # int 타입의 인자들의 총 합을 리턴한다.