1장 코딩 스타일 가이드에 대해서
1.1 읽기 쉬운 코드를 만드는 것이 중요
한번 작성된 코드는 여러번 읽힘. 일관된 스타일로 쓴 코드는 모든 이에게 유용한 정보가 됨
- 축약적이거나 함축적인 변수명은 피한다.
- 함수 인자의 이름들은 꼭 써 준다.
- 클래스와 메서드를 문서화한다.
- 코드에 주석은 꼭 달도록 한다.
- 재사용 가능한 함수 또는 메서드 안에서 반복되는 코드들은 리팩터링을 해둔다.
- 함수와 메서드는 가능한 한 작은 크기를 유지한다.
잊고 지낸 코드라도 어느 순간 다시 보았을 때 빠르게 이해하기 위함.
짧게 쓰는 것 보다 그 의미가 확실한 함수나 변수명이 좋다. -> 기술적 부채를 미리 막을 수 있다.
1.2 PEP 8
PEP 8은 파이썬 공식 스타일 가이드다.
http://www.python.org/dev/peps/pep-0008
- 들여쓰기에는 스페이스 네 칸
- 최상위 함수와 클래스 선언 사이에는 두 줄 띄우기
- 클래스 안에서 메서드들 끼리는 한 줄 띄우기
- 기존 관례는 함부러 바꾸지 않는다
- 79칼럼의 제약 : 코드의 이해도를 떨어뜨리지 않는 수준의 줄 길이
코드 품질을 위해 flake8을 이용하자
- PyCQA 그룹이 관리하는 flake8은 프로젝트를 할 때 코딩 스타일과 코드 품질, 논리적 에러를 점검하는 데 유용함
1.3 임포트에 대해
장고 프로젝트에서 임포트 순서는 다음과 같다
1) 표준 라이브러리
2) 코어 장고
3) 장고와 무관환 외부 앱
4) 프로젝트 앱
Comments