[10-4 파이썬] 독스트링, Docstrings 하는 일

Docstrings 단어를 들여다보면

Document + strings 

의 합성어라는 것을 알 수 있다. 

 

독스트링은

'''    '''

"""  """" 

(따옴표 3개)를 이용해

짧은 문서를 만드는 방법이다.

 

''' 는 시작과 끝에 붙인다.

 

 

독스트링의 예시를 보자.

1. 함수를 설명할 때

def function():
  ''' 독스트링 적기!! 
  여러 줄을 적어도 된다.
  이 함수를 설명하는 짧은 글을 쓴다!'''

함수를 정의한 다음 줄에 들여쓰기를 한 후, 독스트링을 쓴다. 

주석과는 달리 여러 줄을 작성할 수 있다.

 

 

2. 주석을 여러줄로 달고 싶을 때

def function():
  ''' 독스트링 적기!! 
  여러 줄을 적어도 된다.
  이 함수를 설명하는 짧은 글을 쓴다!'''
 
 '''
<여러 줄 주석달기>
this_year = 2022
this_month = 8
this_date = 18
'''

들여쓰기 없이

원하는 곳에 

따옴표 3개를 시작과 끝으로 두고 적으면 된다.

다만 파이썬 공식 문서에는 

여러 줄로 된 주석을 지양하라고 나와 있으니,

#으로 주석을 다는 것을 추천한다.

 

 

주석을 간편하게 달 수 있는 방법은

아래의 게시글을 참고하면 된다.

https://olivia-blackcherry.tistory.com/20

[1-4 파이썬] 주석달기, #, 주석달기단축기, 주석해제하기, 주석지우기, 주석 키보드