[python] docstring(주석)을 넣어 코드를 쉽게 봅시다. ( #, ''')

코드를 짜놓고 다시 돌아보면 내가 왜 저렇게 코드를 짰을까?? 여기에 이 코드가 뭘하는거지??라고 생각해보는 경우 없으신가요? 저도 SW를 업으로 하는 사람이 아니고 취미로 하는 사람이다 보니 내가 원하는 대로 동작하도록 만들어 놓은 코드를 나중에 보면 뭔 말인지 해석이 안되는 경우가 많습니다. 

 

 SW를 업으로 하시는 분들께 주석 처리를 잘 해놔야 좋은 코드라고 많이 이야기를 듣지만 그게 귀찮기도 하고... 뭐라고 써야 할지도 모르겠더군요. 

 

 오늘은 코드를 보다가 파이썬에서 여러줄 주석을 다는 법을 보았습니다.

이게 당연한 건데 제가 어디서 배웠는지 기억이 안나지만, 파이썬의 경우 간단한 코드 구성이기 때문에 "#"표시를 이용한 한줄 주석만 있다고 배웠습니다. 

 # 한줄짜리 주석처리 문구

 

C에도 있는 여러줄 주석처리가 왜 파이썬에 없을까? 언젠가는 생기겠지.. 했는데 이미 있었습니다. 

방법은  " 또는 ' 을 세번 연속해서 넣으면 여러줄 주석이 됩니다. 

"""
여러줄 주석 처리 입니다. 
1번줄
2번줄 
주석 처리 마지막 
"""

 

별것 아닌것 같아도 업무 효율성에 큰 도움이 됩니다. 

제가 어디서 잘못된 정보로 공부한걸까요????