5. 가독성 높은 코드를 작성하라

가독성은 본질적으로 주관적인 것이며 그것이 정확히 무엇을 의미하는지 확실하게 정의하기는 어렵다

가장 일반적이고 효과적인 기법의 토대에 해당하는 지식들이 이번장에서 소개

5.1. 서술형 명칭 사용

이름은 사물이 무엇을 하는지 유추 가능하도록 만든다. (토스터 vs. 객체 A)

를 제공하는 용도로만 주석문을 사용해야 함

코드 줄 수는 아래의 요인 중 하나 이상의 영향으로 늘어난다고 생각한다.

그리고 일반적으로 코드 줄 수가 많으면 개발자의 인지 부하도 증가한다.

1, 2의 경우에는 코드 줄 수를 줄임으로서 인지 부하를 줄일 수 있으나, 3의 경우에는 해결 도메인 자체의 복잡도로 인해 코드 줄 수를 줄일 수 없음

간결하다고해서 가독성이 좋은 것은 아니다. 오히려 아예 알아볼 수 없는 코드가 될 수 있다.

1
2
3
Boolean isIdValid(UInt16 id) {
 return countSetBits(id & 0x7FFF) % 2 == ((id & 0x8000) >> 15);
}

의미를 알 수 없는 값들에 의미를 부여하려면 그 만큼 코드의 양이 늘어날 수 밖에 없음

즉, 코드가 늘어나도 가독성이 높아지는 경우도 있음

로마에 가면 로마법을 따라라

법을 위반하지 않는다고 도덕적인 것은 아니다

필자는 ‘읽기 어려울 수 있다‘라 하고있다. (어렵다 가 아니다)

누군가는 읽기 쉬울 수 있다는 것이다. 읽기 어려울 수 있는 사람을 배려하자는 의미라 생각한다.

논리 재배치로 중첩을 제거 할 수 있음

작은 함수로 나누면 복잡성을 줄일 수 있음

함수 인수도 가독성에 중요한 요소

정의부분을 보지 않으면 매개 변수의 값이 무엇을 의미하는가를 알 수 없는 경우가 있음

해결책으로는

어떤 방법도 훌륭한 해결책이 못되는 경우도 있음, IDE에 의존하는 것은 안좋음 (IDE이외의 환경에서 코드를 볼 수 있음)

매직 넘버 (magic number)를 사용하지 말라

잘 명명된 상수, 공급자 또는 헬퍼 함수를 사용하여 의미를 부여하라

간단한 로직에는 익명 함수가 좋으나, 복잡한 로직에는 명명 함수를 사용하여 가독성을 높여야 함

새로운 기능은 복잡성을 낮출 수 있으나, 오용하면 오히려 복잡성을 높일 수 있음