Function 에 documentation 하는 방법
코드를 이해하고 사용하기 쉽게 만들어주는 주석은 간과하기 쉽습니다. 특히나 팀으로 하지 않고 혼자하는 경우는 더 하지요. 하지만 점점 더 복잡해질수록 본인이 만든 코드/ 스크립트라고 해도 이해하는데 시간이 걸리거나 단번에 확인하여 사용할수 없는 경우도 충분히 많습니다. 그중에서 만들어진 함수 코드에 이해하기 쉬운 글을 다는 방법에 대해서 이야기 해볼까 합니다. 외국 자료에서는 doc-strings (documentation strings)이라는 표현을 주로 쓰는 군요. 일단 예를 한번 볼까요? 백문이 불여일견. def population_density(population, land_area): """Calculate the population density of an area. """ return pop..
2019. 8. 13. 11:42