반응형
1. 문서화 주석
- 개발자가 다른 개발자를 위해 문서화 하는 주석 방법
- 파이참에서 지원하는 기능
- 주로 함수를 만들때 사용함
- 차후를 위해 프로그램 작성시 만들어 주면 좋음
2. 파이참 사용 방법
- 문서화 주석 미사용 시
def say_hello(name):
print('안녕하세요. 저는 %s입니다.' % name)
주석 호출(주석 선택 후 ctrl + q)를 하면 아무것도 표시 안됨
- 문서화 주석 사용 시
def say_hello(name):
'''
이름을 전달 받아서 인사를 하는 함수
:param name: 인사할 때 사용할 이름
:return: 없음
'''
print('안녕하세요. 저는 %s입니다.' % name)
주석 호출(주석 선택 후 ctrl + q)를 하면 문서화 된 주석이 표현 됨
반응형
'Python_Beginer > Study' 카테고리의 다른 글
Python Calss Basic Study - 직원 관리 Class (0) | 2019.05.11 |
---|---|
Python Variable Arguments(가변 길이 함수) - kwargs (0) | 2019.05.11 |
Python Variable Arguments(가변 길이 함수) - args (0) | 2019.05.11 |
Python String(문자열) (0) | 2019.04.28 |
Python Pickling / Unpickling (0) | 2019.04.26 |