Coding Convention

 

1. Coding Convention: 이해하기 쉬운 코드를 위해 존재하는 규칙

 

2. Python의 Coding Convention

- 읽기 좋은 코드 지향

- 일관적으로 할 것

- 들여쓰기는 4space 또는 tab (전자가 일반적)

- 한 줄은 최대 79자까지 할 것을 권장

- 불필요한 공백 지양

- 연산자는 한 칸 이상 띄우지 않을 것

- 주석은 항상 갱신, 불필요한 주석 삭제

- 소문자 ㅣ, 대문자 O, 대문자 I 금지 (폰트에 따라 읽기 어렵기 때문)

- 함수명은 소문자, 공백은 밑줄로 처리 (get_area O, getArea X)

- underscore로 공백을 처리하는 것을 snake_case, 대문자로 공백을 처리하는 것을 CamelCase라고 한다. 변수명은 전자, 클래스명은 후자의 방식을 사용한다.

- flake8 모듈로 체크하면 PEP8에 해당하는 문제가 없는지 검사할 수 있다. (flake8 파일명.py)

- 기본적인 것은 PEP8 참고, 팀/프로젝트별로 상이

 

3. 함수 작성 가이드라인

- 함수는 가능하면 짧게 (줄 수 줄이기)

- 이름에 역할, 의도가 명확하게 드러날 것 (get과 print 구분하여 명명)

- 하나의 함수에는 하나의 역할만 부여

- 인자로 받은 값 자체를 바꾸지 말 것 (같은 변수명을 사용하여 자료구조 변형 후 재할당 등)

- 공통적으로 사용되는 코드는 함수화

- 복잡한 수식/조건은 식별 가능한 이름의 함수화