Devist/clean-code

😎 CLEAN CODE

clean-code-typescript-번역

clean-code-javascript

clean-code-javascript- 번역

1. Clean Code?
2. 필요한 이유
3. 학습법

1. Clean Code?

어떤 것을 clean 하다고 할지, 그것을 정의하는 것이 중요.

좀 더 보편적으로 통용되는 클린코드가 어떤건지 책에서 기술하고 있음.

이 책에서는 오브젝트 멘토들이 추구하는 클린 코드 내용을 담고 있음.

• 성능이 좋은 코드
• 의미가 명확한 코드 ( = 가독성이 좋은 코드)
• 중복이 제거된 코드

보이스카우트 룰

= 캠프장은 처음 왔을 때보다 더 깨끗하게 해 놓고 떠나야 한다.

= 내가 건들기 전보다 더 깨끗한 코드로 만들어야 한다.

멘토들이 생각하는 Clean Code

나는 우아하고 효율적인 코드를 좋아한다.

논리가 간단해야 버그가 숨어들지 못한다.

의존성을 최대한 줄여야 유지보수가 쉬워진다.

오류는 명백한 전략에 의거해 철저히 처리한다.

성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다.

깨끗한 코드는 한 가지를 제대로 한다.

• c++ 창시자, Bjarne Stroustrup

깨끗한 코드는 단순하고 직접적이다.

깨끗한 코드는 잘 쓴 문장처럼 읽힌다.

깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다.

오히려 명쾌한 추상화와 단순한 제어문으로 가득하다.

• Object Oriented Anlysis and Design with Application 저자 Grady Booch

깨끗한 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다.

단위 테스트 케이스와 인수 테스트 케이스가 존재한다.

깨끗한 코드에는 의미있는 이름이 붙는다.

특정 목적을 달성하는 방법은 하나만 제공한다.

의존성은 최소이며 각 의존성을 명확히 정의한다.

API는 명확하며 최소로 줄였다.

언어에 따라 필요한 모든 정보를 코드만으로 명확히 표현할 수 없기에 코드는 문학적으로 표현해야 마땅하다.

• OTI 창립자이자 이클립스 전략의 대부 Dave Thomas

깨끗한 코드의 특징은 많지만 그 중에서도 모두를 아우르는 특징이 하나 있다.

깨끗한 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다.

고치려고 살펴봐도 딱히 손 댈 곳이 없다.

작성자가 이미 모든 사항을 고려했으므로.

고칠 궁리를 하다보면 언제나 제자리로 돌아온다.

그리고는 누군가 남겨준 코드, 누군가 주의 깊게 짜놓은 작품에 감사를 느낀다.

• Working Effectively with Legacy Code 저자 Michael Feathers

클린코드 = 글을 잘 쓰는 것과 일맥상통 한다.

• 읽기 쉬운 코드
• 전달하고자 하는 바를 명확하게 알려주는 코드
• 개발자의 의도가 모두 담겨 있는 코드

2. 필요한 이유?

훌륭한 개발자 혼자 하나의 프로젝트를 전부다 개발하는 시절은 지났다.

협업 능력을 발전 시켜야 하는 시대.

프로젝트를 처음 시작하는 경우를 제외하고는, 다른 사람의 코드를 읽는 시간이 훨씬 많아지게 되었음,

코드를 만드는 시간을 단축하는 것도 중요하지만.

다른 사람이 코드를 읽는 시간을 줄이는 것이 더욱 중요해지며 클린 코드가 각광받게 됨.

작가인 내가 시간을 조금 더 들여 좋은 문장으로 표현하게 된다면, 많은 독자들은 그 코드를 술술 읽게 되고, 더 빠른 시간 안에 해당 내용을 숙지하고, 새로운 코드를 만들거나 수정할 수 있게 됨

클린 코드의 효율성

아래처럼, 개발자 혼자였다면 효율이 떨어지지만. 협업의 시대에서는 오히려 효율성이 증가함. (ex, 오픈소스)

• 일반 코드
  • 개발자 : 1시간 코딩
  • 네 명의 협업자가 코드 이해 : 1시간 * 4명 = 4시간
• 클린 코드 ( 위 코드를 개발자가 좀 더 공들여 만듦 )
  • 개발자 2시간 코딩
  • 네 명의 협업자가 코드 이해 : 0.5시간 * 4명 = 2시간

학습법

1. 일단, 클린코드 책을 읽어본다.
2. 직접 적용해보기
   1. 내가 담당한 프로젝트에서 나쁜 코드를 발견하고 리팩토링해보기
   2. 새로 만드는 코드를 clean code 룰에 맞춰 만들어보기
   3. 프로젝트에 맞는 clean code 룰을 만들어보기
3. 좋은 코드 읽어보기
   1. 담당하고 있는 프로젝트에서 좋은 코드를 찾아보기
   2. 오픈 소스로 제공하는 코드에서 좋은 코드를 찾아보기

😎 리뷰 복습

나쁜 코드

성능이 나쁜 코드

불필요한 연산이 들어가서 개선의 여지가 있는 코드

의미가 모호한 코드

• 이해하기 어려운 코드
• 네이밍과 그 내용이 다른 코드

중복된 코드

• 비슷한 내용인데 중복되는 코드들은 버그를 낳는다.

나쁜 코드가 나쁜 이유

깨진 유리창 법칙

나쁜 코드는 깨진 유리창처럼 계속 나쁜 코드가 자라나도록 한다.

생산성 저하

나쁜 코드가 쌓일수록 기술부채가 쌓이기 때문에 생산성을 굉장히 떨어뜨린다.

결국에는, 새로운 시스템을 만들어야 한다.

현재시스템을 유지보수하며 대체할 새로운 시스템 개발은 현실적으로 매우 어렵다.

(올드시스템과 뉴 시스템이 같은 요구사항을 수렴하면서, 새로운 뉴 시스템으로 나아가는게 진짜 쉽지 않다.)

나쁜 코드를 짜는 이유?

일정이 촉박해서

하지만... 나쁜 코드는 생산성을 저하하기 때문에 오히려 일정을 못맞춘다.

영향 범위가 넓어서

생각보다 영향 범위가 넓어서 건드렸다가 다른 부분에 버그가 발생할까봐 (사이드 이펙트)

하지만... 기술 부채는 부메랑처럼 우리에게 돌아온다.