파이썬 문서화하기 - docstring
소스코드는 한번 짜면 끝이 아닙니다. 프로그램이 문제없이 돌아가기 위해서는 유지보수를 계속 해야합니다. 유지보수를 위해서는 네이밍 규칙 정하기, 간결한 코드 작성, 버전 관리 툴 사용등과 같은 방법이 있습니다. 하지만 그 무엇보다도 코드가 어떤 동작을 하는지, parameter은 무엇이고 return 값은 무엇인지에 대해서 문서화를 해야 새로운 팀원이 코드를 봐도 빠르게 이해하고 팀에 녹아들 수 있을것입니다. 저는 개발자가 많은 프로젝트에 참여한 경험이 없어서, 이때까지 문서화에 소홀히해왔습니다. 최근 파이썬으로 진행한 프로젝트가 커지면서 문서화가 필요하다고 생각해서 공부하게 되었고 그 내용을 포스팅으로 정리했습니다. 1. Docstring 위치 함수 선언부 바로 아래에 따옴표를 사용해서 작성할 수 있습..
major/Python
2020. 4. 18.