[VS Code Extension] autoDocstring 추천! VS Code Python Docstring Generator

오늘 소개해 드릴 것은 autoDocstring이라는 VS Code Extension입니다. 요즘 다들 python으로 개발할 때에 VS Code 많이 사용하시죠? 저만 그런가요?ㅎㅎ 워낙 extension도 좋고, ssh connection이나 jupyter notebook/lab에 연결해서 python 실행도 가능하고, conda 환경도 클릭으로 선택 가능하고... 너무 편리해서 저는 vs code로 옮겨왔는데요! 다들 이미 많이 쓰고 계실 수도 있겠지만, 저는 최근에 발견해서 추천해드립니다!

 

autoDocstring

 

사실 이렇게 argument, keyword arguemnt, raise, return 등을 명시하는 것이 익숙하지 않으신 분들도 계실 것이고, 귀찮으신 분들도 계실 겁니다. (저는 둘돠) 누가 시켜서 이런 것을 시작하는 것은 아니지만, 좋은 습관을 들이기 위해서 저는 시작해보려 합니다! :) 여러분도 함께해요! 이런 정보가 담긴 주석을 docstring이라고 합니다!

 

탬플릿을 빠르게 생성해주고, 탭으로 쓸 부분을 쉽게 옮겨다닐 수 있다는 장점과 여러 유형의 docstring formats을 제공합니다.

 

autoDocstring에서 지원하는 Docstring Formats은

1. Google (default)

2. docBlockr

3. Numpy

4. Sphinx

5. PEP0257 (coming soon)

가 있습니다!

 

여러분이 한번 보시고, 가장 편한 스타일로 고르시면 됩니다!

 

"""이나 '''로 주석을 시작하셨던 것처럼, 이에 엔터를 치면 (extension이 설치된 상태에서) 자동으로 나타나게 돠ㅣ구요,

단축키로 사용하시려면 ctrl(cmd)+shift+2 를 입력하시면 됩니다!

 

우리 모두 더 깔끔하고 재사용이 가능한 코드를 작성하기 위하여 노력합시다!! :)

 

ref: github.com/NilsJPWerner/autoDocstring

NilsJPWerner/autoDocstring