읽기 좋은 코드가 좋은 코드다
03 Aug 2019
코드는 이해하기 쉬워야 한다. 단지 간결하다고 해서 가독성이 좋은건 아니다. 코드는 다른 사람이 그것을 이해하는 데 들이는 시간을 최소화 하는 방식으로 작성 되어야한다. 여기서 이해란 그 사람이 코드를 수정하고, 버그를 고치고, 다른 코드와 상호작용 하는지 알아야 한다는 의미. 내가 1회용으로 작성한 코드가 다른 어딘가에서 사용될 수도 있음. 즉 내가 나중에 이해해야 되는 상황이 올 수 있다는 의미. 이름에 정보를 담되 좀더 적합한 단어를 사용해야된다. ex) send -> deliver, dispathch, find-> search, extract, locate, recover
불필요한 단어 제거도 필요. ex) ConvertToString -> ToString, DoServerLoop -> ServerLoop
다른 사람이 봤을때 오해할 수 있는 이름(애매한)은 좀더 나은 이름으로 대체 해야한다. ex) filter()가 제거인지 고르는것인지 미학적으로 보기 좋은코드가 사용, 읽기 편한건 사실. 일관성 있는 스타일은 올바른 스타일보다 중요하다. 프로젝트에서 일관성있게 모두가 사용한다면 올바른 스타일보다 나을 수 있음. 주석은 설명할 수 없는 내용을 달고, 주석이 길고 어려워지면 코드를 수정.
주석은 간결하게 ! 영리한 코드에 유의, 나중에 내가 읽든 다른 사람이 읽든 힘듬. 한번에 하나의 작업만 수행하게 코드를 구성. Get이면 Get의 기능만.