[클린코드] 클린코드와 코드포매팅

Colacan·2022년 5월 27일
1

[파이썬 클린코드]

목록 보기
1/3

각 파트의 첫 줄에는 본인의 언어로 설명을 적고 이후에 학습한 내용을 정리했다.

클린코드의 중요성

다른이와의 소통, 유지보수면에서 중요하다.

  1. 유지보수성 향상 : 민첩한 개발과 지속적인 배포를 가능하게 한다.

  2. 기술부채의 감소 : 이전의 나쁜결정이나 타협으로 생기는 부채를 감소시킨다. (부채는 지속될수록 커진다!)

  3. 애자일 개발을 통한 효과적인 작업 진행

  4. 성공적인 프로젝트 관리

코드포매팅

말그대로 코드를 구조화하는 것

  1. PEP-8 처럼 가이드라인을 정확히 지킨다고해서 클린코드가 되는 것은 아니다.

  2. 하지만 작업을 효율화하기 위해서 중요하다.

코딩스타일 가이드

통일된 코드형식을 위한 것 (이런 과정을 코드 컨벤션이라고한다.)

  1. 일관성을 위해서 중요하다

  2. 신속하게 패턴을 파악하고 오류를 감지할 수 있다.

  3. 정적 분석도구를 통해서 버그의 개수를 줄일 수 있다.

PEP8

파이썬의 개선 제안서, 일관성있는 스타일

  1. 변수 및 함수 : 스네이크 표기법 (한단어는 소문자, 여러단어는 언더바로 연결)

  2. 상수 : 스네이크 표기법 이용, 소문자가 아닌 대문자로 작성

  3. 들여쓰기 : space4개를 쓰는 것을 채택, Tab은 작성된 코드가 이미 Tab을 사용했을 경우만 사용

  4. 괄호 : 괄호안에서는 띄어쓰기 x

  5. 함수호출 : 함수 이름과 괄호사이에 띄어쓰기 x

  6. 쉼표 : 콤마,세미콜론,콜론 앞에 띄어쓰기 x

  7. 할당 연산자 : 할당 연산자 앞뒤로는 한개씩 띄어쓰기

  8. 블록 주석 : 해당 코드와 동일한수준의 들여쓰기, # 뒤에 한 칸의 띄어쓰기

  9. 인라인 주석 : 실행코드와 같은줄에는 되도록 사용 x 쓴다면 두 칸 이상의 띄어쓰기

검색효율성

PEP-8에서 검색의 효율성을 위한 스타일

  1. PEP-8에서 키워드 인자에 값을 할당할때는 띄어쓰기 사용 x
    "location="

  2. 변수에 값을 할당할 때에는 띄어쓰기 사용 o
    "location ="

profile
For DE, DA / There is no royal road to learning

0개의 댓글