문서화

• 문서화의 형식에 관해 꼭 지켜야 할 규칙은 없음
• But. 흔히 사용하는 포맷은 존재

Google Docstring

"""유저에서 추천할 영상을 찾아준다
Parameters:
number_of_suggestions (int): 추천하고 싶은 영상 수. 기본값은 5

Returns:
list: 추천할 영상 주소가 담긴 리스트
"""

reStructuredText

"""유저에서 추천할 영상을 찾아준다
:param number_of_suggestions: 추천하고 싶은 영상 수. 기본값은 5
:type number_of_suggestions: int

:returns: 추천할 영상 주소가 담긴 리스트
:rtype: list
"""

NumPy/SciPy

"""유저에서 추천할 영상을 찾아준다

Parameters
----------
number_of_suggestions: int
  추천하고 싶은 영상 수 (기본값은 5)

Returns
-------
list 
  추천할 영상 주소가 담긴 리스트
"""

코드잇에서 자세히 알아보기

• 문서화 스타일