코딩 규약(Coding Conventions)
목적
코드의 작성 규칙이 실행 결과에는 크게 영향을 끼치지는 않으나, 일관된 형식을 갖추어 코드를 작성하게 함으로써 더 향상된 품질의 소스를 통해 유지보수를 용이하게끔 할 수 있다.
대표적인 코딩 규약 명세서 : PEP 8
PEP 8 코딩 규약 명세서 내용
- 들여쓰기 공백 4칸
- 최상위 함수, 클래스 정의 2줄 띄어 쓰기
- 클래스 내 메소드 정의 1줄 띄어 쓰기
- [] 안, () 안, ,(콤마), :, ; 등의 앞에는 공백 제거
- i, I, O는 문자 구분이 어려워 가급적 사용않기
- 모듈명은 간단한 소문자로 구성, 필요시 밑줄 구분
- C/C++ 확장 모듈은 밑줄로 시작
- 클래스명은 카멜 표기법 작성
- 시스템 내부적으로 사용하는 객체명 앞에는 밑줄을 붙임
- None 비교 시 is나 is not만 사용