낭 만 당

[Study] Clean Code: Week 1 본문

Programming Record

[Study] Clean Code: Week 1

낭만알파카 2024. 10. 16. 12:54

Clean Code(클린 코드)

로버트 C.마틴 저자

(글) 박재호, 이해영 번역

매주 화요일 오후 8시 클린 코드에 대해 이야기하는 스터디를 시작했다.

10/15 1주차이다.


1주차 학습 챕터

1) 깨끗한 코드

2) 의미있는 이름


1. 깨끗한 코드

  • 나쁜 코드에 대한 경고
    • “나중”은 오지 않는다. 미루는 것은 문제를 키울 수 있다.
    • 나쁜 코드의 생산성은 시간이 지날수록 0에 가까워진다.
    • 작은 부분이라도 신경 써서 작성해야 한다.
    • 초기의 소홀함이 큰 문제로 이어질 수 있다.
  • "깨끗한 코드란 무엇인가?"
    • 추가적인 주석과 가이드북 없이도, 처음 보는 개발자가 기능을 짐작하고 이해할 수 있어야 한다.

2. 의미 있는 이름

  1. 의도를 분명히 밝혀라
    • d, x, n, m 같은 변수명 대신 daySinceCreation, fileAgeInDay 사용.
  2. 그릇된 정보를 피하라
  3. 의미 있게 구분하라
    • source와 destination을 명확히 구분하여 코드 읽기를 쉽게 만들기.
  4. 발음하기 쉬운 이름을 사용하라
    • 축약어 사용을 피하라.
  5. 검색하기 쉬운 이름을 사용하라
  6. 인코딩을 피하라
  7. 과도하게 긴 변수명을 피하라
    • 자신의 기억력을 자랑하지 마라.
  8. 클래스 이름: 명사나 명사구
    메서드 이름: 동사나 동사구
  9. 과도하게 기발한 이름은 피하라
    • 말장난을 하지 말기.
  10. 한 개념에 한 단어를 사용하여 연결하라
  11. 해법/문제 영역에서 가져온 이름을 사용하라
  • 코드를 읽는 사람은 "프로그래머".
  1. 의미 있는 맥락을 추가하라
  • 예) firstName -> addrFirstName
  1. 불필요한 맥락을 없애라
  • 예) KoreanAddrFirstName