[WebDev] Clever code is probably the worst code you could write

 

Clever code is probably the worst code you could write

---

def mininumTotal(self, t):
	return reduce(lambda a,b:[f+min(d,e)for d,e,f in zip(a,a[1:],b)], t[::-1])[0]

위 코드는 흔히 “코드 골프”라고 불린다. 취미로는 좋을 수 있지만 “좋은 코드”와는 거리가 멀다.

모두들 이것이 좋은 코드가 아니라는 것은 알고있다. 실제 업계에서는 가장 나쁜 코드 중에 하나라고 할 수 있다.

반대로 생각해보면 가장 명확한 코드를 작성하는 것이 실제로 가장 어려운 일인 것이다.

시니어 소프트웨어 엔지니어의 코드를 리뷰하는 것이 엔트리 레벨 L3 엔지니어의 코드를 리뷰하는 것보다 훨씬 쉽다는 말이 이해가 될 것이다.

 

Clear code: the good and the bad

나는 두개의 파일로만 구성되어있던 복잡한 스파게티 코드를 30개 이상의 diff로 나누어 구현하였다.

구조화된 코드 조각인 각각의 diff는 정돈되어있었다. 코드는 적재적소에 헬퍼 함수화 헬퍼 파일로 깔끔하게 분리되어있었다.

 

각 diff는 합리적인 단위 테스트 커버리지를 가지고 있었다. 기본적인 부분과 몇몇의 명백한 엣지 케이스가 포함되었고 이는 지나치게 과하지도 않았다.

 

각 diff는 여러번의 코드 정리, 리팩토링, 그 외 등등의 과정을 여러번 거쳤다. 명확한 코드(clear code”)를 작성하는 것은 예상보다 훨씬 더 많은 노력이 들었고, 특히 큰 프로그램에서는 더욱 그랬다.

결과는? 읽기 쉽고 명확한 데이터 보강 모듈이 아름답게 완성되었다.

하지만 매니저와 이것에 대해 이야기를 할 때 문제가 발생했다.

“이 코드가 얼마나 복잡했었는지 알지만, 성과 리뷰 측면에서는 이 코드는 매우 사소해 보여. 너무 쉽고 단순해보여.

이 모듈에 대한 구현 문서를 작성해서 실제로 이것이 꽤 복잡했다는 것을 증명할 수 있도록 하는것을 추천해.”

여기는 스타트업도 아니고 엔지니어링 문화에서 잘 알려진 세계적인 회사 중 하나였다.

 

이제야 왜 대기업들이 많은 문서들을 가지고 있는지 이해했다. 내가 쓴 문서 중 반은 작성할 필요가 없었지만, 작성 해야했다. 왜냐면 나는 임금 인상과 승진을 원했으니까!

 

여기서 핵심은 좋은 코드는 매우 명확하고 읽기 쉬웠다는 것이다.

 

디버깅하는 것이 코드를 작성하는 것보다 두배는 어렵다라는 유명한 말이 있다. 이것이 바로 ChatGPT가 엉터리 결과를 출력할 때, 오류를 찾아내기보다 다시 요청하거나 처음부터 직접 작성하는 것이 더 쉬운 이유이다.

영리한 코드는 읽기 더 어렵고 난해해 보인다.
명확한 코드는 쓰기 어렵고 쉬워 보인다.

 

Some other thoughts about clear code

난가..

• 명확하고, 읽기 쉬운 코드를 작성하는데에 능숙해진 유일한 방법은 명확한 스타일 가이드를 엄격하게 따르면서 많은 코드를 작성했던 것이다.
  • 또한, 경험 많은 개발자들이 나의 코드를 꼼꼼하게 리뷰해주는 것도 도움이 되었다.
    • 처음에 무의미해보이는 스타일 가이드에 대한 수 많은 코멘트와 “nits”를 받는 것이 고역이었지만, 결국에는 큰 도움이 되었다.
• 코딩 스타일은 내가 예상했던 것 보다 훨씬 중요하다. 나는 소프트웨어 엔지니어링을 제품 중심적인 마인드에서 시작하여 점차 “기술 중심”적인 마인드로 이동하였다.
  • 나는 사업을 혼자 시작하기 위해 코딩을 시작했기 때문에, 코드를 오직 도구로써로만 집중했다. 그 결과 유지보수가 되지 않은 엉망인 코드가 나왔다.
  • 많은 코딩 경험을 쌓고 팀 내에서 함께 일하면서 명확하고 읽기 쉬운 코드의 중요성이 더욱 분명해졌다.
  • 1년 이상 코딩을 해본 사람 누구나 깨닫게 되는 명백한 사실이다.

---

👩‍💻 Opinion

두번째 짤은 진짜 난가..

처음 취준 시절, 알고리즘을 한창 공부할 시절에는 "코드 짧게 쓰기, 내장 함수 다 갖다 쓰기" 에 조금 집착을 했던 것 같다. 어려워 보이는 코드가 나의 전문성을 올려준다고 생각했다. (실제로 그럴지도 모르겠다. 취준생 시절에 여러 메소드를 활용하는 능력도 돋보이지 않았을까..)

 

하지만 2년차 조금 안된 지금 나는 두번째 짤에 가깝다 ㅋㅋㅋ. 복잡한 코드를 보면 '똑똑하다'라는 생각보다 '읽고 싶지 않다'라는 생각이 스멀스멀 든다.. 그러면서 나의 코드도 반성하고 요즘엔 읽기 쉽게 작성하기에 빠져있다. 그러다 찾아온 이 글! 내가 올바르게 성장하고 있다고 느낀다 :)

 

회사에서는 코드 내에서 나의 전문성(?인지도 모르겠다 이젠..)을 강조하는 것이 과연 좋을까?

누군가가 나의 코드를 읽고 읽기를 포기하거나, 이해가 어려워 나를 꼭 찾게된다면 팀의 효율성이 확연히 낮아질 것이다.