4.4 클린 코드 작성

클린 코드 작성 : 의미 있는 이름 사용하기

 

서술적이고 암시적인 유형

Boolean의 경우 조건임을 명확히 하기 위해 is_ 또는 has_로 접두사를 지정할 수 있다. 또한 함수에 동사를 사용하고 변수에 명사를 사용하는 것과 같은 유형의 말을 사용할 수도 있다. 일관되지만 명확하게 구분하라. age_list와 age는 ages와 age보다 구별하기 쉽다.

 

약어 및 단일 문자 피하기

코드에 대한 대상자를 기준으로 이러한 예외를 적용할 시기를 결정할 수 있다. 다른 데이터 과학자와 함께 작업하는 경우 특정 변수가 상식이 될 수 있다. 전체 스택 엔지니어로 작업하는 경우 이러한 경우에도 더 많은 설명적 이름을 제공해야 할 수 있습니다 (예외에는 카운터 및 일반 산술 변수 포함).

 

긴 이름은 설명하는 이름이 아니다

설명해야 하지만 관련 정보만 있어야 한다. 예를 들어, 좋은 함수 이름은 구현에 대한 세부사항이나 매우 구체적인 용도를 포함하지 않고 그들이 잘하는 것을 묘사한다.

 

코드를 보지 않고 동료 프로그래머에게 함수 또는 변수의 용도를 이름에 따라 추측하도록 요청하여 이름이 얼마나 효과적인지 테스트하자. 의미 있는 이름을 생각해 내는 것은 종종 옳게 되기 위한 노력이 필요하다.

 

---

클린 코드 작성 : 공백의 중요성

 

일관된 들여쓰기로 코드 구성

각 들여쓰기에 대해 4개의 공백을 사용하는 것이 표준이다. 텍스트 편집기에서 이 값을 기본값으로 설정할 수 있다. 코드를 잘 구성하고 읽을 수 있도록 빈 줄로 섹션을 구분한다. PEP 8 스타일 가이드에 나와 있는 가이드라인인 79자 정도로 대사를 제한하라. 대부분의 양호한 텍스트 편집기에는 79자 제한이 있는 위치를 나타내는 미묘한 줄을 표시하도록 설정할 수 있다.

 

PEP 8 guidelines for code layout

PEP 8 -- Style Guide for Python Code