collaboration

newhyork·2022년 6월 16일
0

docstring


  • 함수 등에 주석으로 문서를 남겨두는 것으로써, 주로 협업을 할 때 도움 된다.
  1. VSC extension에서 autoDocstring을 설치한다.
  2. docstring template을 적용할 프로젝트의 root directory에서 .vscode/ 디렉터리를 생성한다.
  3. epytext.mustache라는 파일을 생성하고, 아래 내용을 적는다. (커스텀하기 나름이다)
{{! Epytext Docstring Template }}

{{summaryPlaceholder}}

{{#parametersExist}}
{{#args}}
@param {{var}}: {{descriptionPlaceholder}}
{{/args}}
{{/parametersExist}}
{{#returnsExist}}
{{#returns}}
@return: {{descriptionPlaceholder}}
{{/returns}}
{{/returnsExist}}
{{#exceptionsExist}}
{{#exceptions}}
@raise {{type}}: {{descriptionPlaceholder}}
{{/exceptions}}
{{/exceptionsExist}}
  1. ctrl+, 으로 VSC 설정을 열고, docstring을 입력하여 path에 위 파일의 절대 경로를 입력한다.
  2. 앞으로 코딩에 있어서 함수 등 작성을 마치고 관련하여 주석으로 문서를 남기기 위해,
    시작 부분에서 ctrl+shift+2를 하여 커스텀한대로 template을 생성하고 알맞게 문서를 작성한다.

(ref. https://blog.naver.com/burnnine3/222557497097)


linter


  • 코딩을 하면서 발생한 불필요한 요소 등을 제거할 때 사용한다.
  1. pip로 flake8 라이브러리를 설치한다. (마음에 드는 것으로..)
  2. VSC에서 ctrl+shift+p로, linter를 검색하여 flake8을 선택한다.
  3. 열려있는 파일에 대해, VSC 하단의 '문제' 영역에서 linter에 따라 수정이 필요한 부분들을 확인할 수 있다.

git commit message convention


0개의 댓글