Clean Code #004

# 저작권 자유 이미지 출처 by Unsplash

# 의도를 분명히 밝혀라

- 변수명은 시간이 걸리더라도 명확하고, 명시적인 단어로 정한다.

- 명확하게 지정되지 않은 경우, 이후에 코드를 읽고 이해하는 시간이 더 걸린다.

    - 특히 매직넘버는 사용하지 않는다.

# 그릇된 정보를 피한다.

- 실제로 데이터 타입이 List가 아닐경우, 변수에 -List 명칭은 사용하지 않는다.

# 의미있게 구분하라

- 일관성 있는 변수를 사용한다.

- 단수일 경우, 접미사로 -info, -data같은 불필요한 접미사를 사용하지 않는다.

    # 기본

    - 의도를 분명하고 솔직하게 표현한다.

    - 한 개념에 한단어를 사용한다.

    # 변수명

    - 변수명에 타입에 관련된 접두어나 접미어를 사용 하지 않는다.

    - 클래스, 객체 이름은 명사나 명사구를 사용한다.

        -ex) Customer, WkiPage, Account

    # 메서드명

    - 동사를 주로 사용한다.

        - ex) getName, postPayment

    # 클래스 분리

    - 사용하는 변수가 최소 4개만 넘어가도 별도 엔티티로 분리한다.

# 의미있는 맥락을 추가한다.

- 메소드 분리를 통해 맥락을 파악할 수 있도록 개선한다.

- 사실 지금까지 배운 위 내용들의 종합인듯하다.

- 고민한 부분은 공유하고, 팀원들과 소통을 통해 리팩토링하여 계속 개선한다.

출처: <클린코드> 로버트 마틴 지음, 박재호 이해영 옮김, 2013년 인사이트

Thanks Amith Nair