Coding Convention
Team RAYN은 팀원의 코드를 쉽게 이해하고 관리할 수 있도록 코딩 컨벤션을 설정하였습니다!
코딩 컨벤션은 코드 컨벤션과 코멘트 컨벤션으로 나뉘어집니다.
- 파이썬을 사용함으로, 함수명/변수명은 스네이크 케이스로 작성합니다.
- 클래스명은 카멜 케이스로 작성합니다.
- 가독성을 위해 한줄에 하나의 문장만 작성합니다.
- 연산자 사이에는 공백을 두어 가독성을 높입니다.
- 콤마(,) 다음에 값이 올 경우, 가독성을 위해 공백을 둡니다.
- black을 이용하여 파이썬 코드 스타일을 통일하며, isort를 이용하여 라이브러리 정렬을 합니다.
pip install black pip install isort
- vsCode Extension인 autoDocstring을 이용하여 주석을 작성합니다.
- Extension 사용을 통해 팀원 모두가 통일된 양식의 주석을 작성할 수 있습니다.
- 큰따옴표(”)를 연속으로 3개 입력하고, Enter를 입력하면 다음과 같은 주석 양식이 나타납니다.
- summary에는 해당 기능에 대한 요약을 작성합니다.
- Args에는 input에 대한 타입과 설명을 작성합니다.
- Returns에는 output에 대한 타입과 설명을 작성합니다.
- 팀원이 주석을 읽고 내용을 쉽게 이해할 수 있도록 친절하게 작성합니다.
개발 과정에서 코드 컨벤션 및 코멘트 컨벤션을 따르면서 협업을 진행하였습니다!