읽기 좋은 코드가 좋은 코드다

 

http://www.yes24.com/Product/Goods/6692314

읽기 좋은 코드가 좋은 코드다

 좋은 코드는 엔지니어의 숙제다. 프로젝트가 시작되면 큰 규모로 다양한 사람들이 프로젝트에 참여한다. 그래서 개발자는 협업을 위해 좋은 코드를 작성하고 코드의 가독성(readability)을 높이는 것이 중요하다. 그렇다면 읽기 좋은 코드란 무엇일까? 구글 출신 개발자가 읽기 좋은 코드가 무엇인지 정리했다.

 

1. 코드는 이해하기 쉬워야 한다

 코드는 다른 사람이 그것을 이해하는 데 들이는 시간을 최소화하는 방식으로 작성한다. 적은 분량으로 코드를 작성하는 것은 좋지만, 다른 사람들의 이해를 위한 시간을 늘리지는 말아야 한다.

 

2. 이름에 정보를 담아내라.

 이름만 보고도 다른 엔지니어가 어떤 의미인지 바로 이해할 수 있어야 한다. 보편적인 이름인 tmp, size 같은 단어 대신 Height, NumNodes같은 구체적인 이름을 이용하라.

 

3. 시각적으로 보기 좋은 코드가 사용하기 더 편하다.

 ‘컴퓨터 프로그램의 구조와 해석(SICP)의 서문에 ‘프로그램은 사람들에게 읽히기 위한 목적으로 만들어야 하고, 우연히 컴퓨터가 실행할 수 있다면 더욱 좋다’라는 글이 나온다. 코드를 읽는 주체는 사람이기 때문에, 소스코드는 사람이 보기 편해야 한다. 코드는 읽는 사람에게 친숙하고 일관성을 유지해야한다.  

 

4. 명확하고 간결한 주석 달기

주석의 목적은 코드를 읽는 사람이 코드를 작성한 사람만큼 코드를 이해하기 쉽게 돕는 것이다. 주석보다 코드 자체에서 의미가 유추가 되어야한다. 주석은 간결해야 하고, 주석이 설명을 위한 설명이 되지않게 해야한다.

 

개발자들이 코드의 가독성보다는 기능의 완성에 더 초점을 두고 있는 것이 현실이다. 하지만 안정적인 운영과 협업을 위해 ‘읽기 좋은 코드’를 만드는 것이 정말 중요하다. 자신을 코드를 읽는 입장에서 코드를 구현하라는 책의 문구가 마음에 든다. 일상에서 작성하는 코드에 이 책의 철학이 담겨있도록 노력해야겠다.