Python Docstring

원래 주석을 잘 달지 않는다. 혼자 다 하는데 무슨 주석이 필요한가? 다 코드에 변수에 흔적이 남아 있는데 그렇지만 중요하고 복잡한 함수와 협업에 필요한 곳에는 꼭 상세하게 달아야 한다.

나중에 html에 어떻게 변환될 지는 두째치고, 우선 내 코드에서 보기 좋은 컨벤션을 선택해야 하는데, 한 눈에 보면 비교가 편할 것 같아 정리해봤다.

python docstring convention 비교

google

google-notypes

docblockr

pep257

sphinx

sphinx-notypes

one-line-sphinx

numpy

numpy-notypes

한눈에 보기에는 one-line-sphinx 가 좋아 보인다. 일단 pick!