좋은 코드를 작성하는 것에 대해 서술한 책에서 읽었던 내용 중 기억하고 싶은 부분들..

좋은 코드의 정의

좋은 코드에 대해 정의와 각각의 의미는 다음과 같다.

유지보수성이 높다

작성한 코드는 오랜 기간 사용된다. 그러므로 나중에 보아도 어떠한 동작을 하는지 이해 하기 어렵다면 좋은 코드라 할 수 없다. 즉, 타인이 봐서 이해할 수 있는 코드여야 한다.

신속하고도 효율적으로 동작한다

어떤 기능에 대해 다양한 구현방법이 존재할 때, 효율이 안좋은 쪽은 선택할 필요가 없다. 좋은 코드는 좋은 성능으로 동작한다

정확하게 동작한다

코드를 작성하며 “항상 정상적인 값이 올 것이다”라고 단정짓지 않고 비정상적인 값이 오더라도 피해를 받지 않더록 방어적으로 작성한다.(방어적 프로그래밍) 그 이유는 좋은 코드는 방어적이므로 예상치 못하느버그가 쉽게 발생하지 않는다.

불필요한 부분이 없다

불필요한 처리가 없는 코드는 이해하거나 수정하는 것이 간단하여 시간이 많이 소요되지 않는다. 코드내에서 반복되는 패턴을 짧게 하는 방법은 추상화가 있음.

좋은 이름 짓기

좋은 코드 작성을 위해서는 타인이 해당 코드의 변수명, 메소드명만 보고도 그 의미를 알 수 있어야 한다.
그러기 위해서는 좋은 이름을 명명해주어야 한다.

설명적이고 의미, 의도를 나타내야한다.

변수나 메소드명을 지을 때 약어를 사용하는 경우. 단축어 검색 사이트를 활용하여 참고하면 편리하다.

일관성이 있어야한다

코드 전체를 통해 일관된 정책으로 명명되어야한다.

영어로 부여되어야 한다

적절한 영단어를 사용해 이름을 부여함으로써 의도가 정확하게 전달되어야 한다. 영단어로 명명하는 경우 다음과 같은 점을 유의해야한다

  • 존재하지 않는 단어로 명명하지 않기
  • 스펠링을 틀리지 않도록 하기
  • 오역에 주의하기

관용 표현을 따르고 있어야 한다

코딩 표준을 따라야 한다

각 프로젝트에서 코딩 표준이나 명명 규약을 정해서 서로 지켜나가는 것이 중요하다