22.03.24 [읽기 좋은 코드가 좋은 코드다] - 더스틴 보즈웰, 트레버 파우커

📍 책을 읽게 된 계기

 

팀 프로젝트 진행에 앞서 팀 규칙을 정하게 된다.

이때 변수명, 파일명 등 얕은 코드 스타일을 통일시켜놓고 시작할 수 있는데,

어떤 걸 기준으로 정해야되는지 모르겠더라.

읽기 편하다는 기준도 엉망이고 ..!!

팀 단위 작업을 할때 적어도 좋은 규칙을 제안할 수는 있어야겠다는 생각에 읽게 되었다.

 

---

💡 목차

1. 표면적 수준에서의 개선
     ✔ 이름에 정보 담기
     ✔ 오해할 수 없는 이름들
     ✔ 미학
     ✔ 주석에 담아야 하는 대상
     ✔ 명확하고 간결한 주석 달기 
2. 루프와 논리를 단순화하기
     ✔ 읽기 쉽게 흐름제어 만들기
     ✔ 거대한 표현을 잘게 쪼개기
     ✔ 변수와 가독성
3. 코드 재작성하기
     ✔ 상관없는 하위 문제 추출하기
     ✔ 한 번에 하나씩
     ✔ 생각을 코드로 만들기
     ✔ 코드 분량 줄이기
4. 선택된 주제들
     ✔ 테스트와 가독성
     ✔ 분/시간 카운터를 설계하고 구현하기

 

 

 ✔ 이름에 정보 담기 

 

• 특정한 단어 고르기

 

상황에 따라 Get 대신 Fetch나 Download를 사용하는 것이 더 낫다. → 최대한 구체적으로 적기

 

ex.

단어	대안
send 전송하다	deliver / dispatch / announce / distribute / route
find 찾다, 발견하다	search / extract / locate / recover
start 시작하다	launch / create / begin / open
make 생성하다	create / set up / build / generate / compose / add / new

어디까지나 예시다. 상황에 더 적합한, 알맞은 단어를 쓰려고 최대한 노력할 것 ❗

 

 

• 보편적인 이름 피하기

 

당시 상황을 제대로 표현하는 단어가 아니라면, 보편적인 이름은 최대한 피하자.

보편적인 이름을 사용하려면 꼭 그렇게 해야하는 이유가 존재해야 할 것이다 ❗ - ❗

 

ex.

3중 for문을 돌때 우리는 보편적으로 i, j, k ... 순의 알파벳 전개를 많이 사용한다.
크게 잘못된 점은 없는데, 그래도 읽기 편하게 개선하자면
→ if (clubs[ci].members[mi] == users[ui])
이런식으로 헷갈리는 일 없게 정리할 수 있겠다 ㅎㅎ

 

 

• 추상적인 이름보다 구체적인 이름을 사용하기

 

ex.

🔗 (IN C++) DISALLOW_EVIL_CONSTRUCTOR → DISALLOW_COPY_AND_ASSIGN
C++에서는 프로그래머가 클래스를 위한 copy constructor나 assignment operator를 생략하면, 자동으로 기본값을 제공한다. 이는 편리한 기능이지만 우리가 알지 못하게 벌어지기 때문에 메모리 누수나 각종 문제를 일으킨다.
결과적으로 구글은 매크로를 사용해서 사악한 생성자가 만들어지는 것을 불허하는 정책을 사용하기로 했다.
그러나 EVIL은 굉장히 주관적인 표현이고 DISALLOW하는 대상도 드러나지 않는다. (모호모호)
또한 operator=() 를 금지하는데 이는 생성자도 아니기 때문에 ㅋㅋㅋ 결국 이름이 변경되고 만다.

🔗 (IN command-line-flag) --run_locally
→ 이 플래그가 선택되면 프로그래밍은 디버깅 정보를 출력한다.
→ 이 플래그의 문제점
• 팀에 새로 합류한 사람은 무엇을 위한 플래그인지 알 수 없다.
  → 로컬에서 사용하는 플래그인가 ..? 짐작/추정하게 만들지 않기 !!
• 프로그램을 원격 컴퓨터에서 실행할 때도 디버깅 정보를 출력할 수 있는데, 이때 run locally 이라 .. ㅋㅎㅋ
  → 여러가지 상황을 고려한 작명 센스가 필요함 !!
• 로컬에서 성능검사를 수행할 때 로깅 기능으로 인한 성능 저하를 원치 않는 경우도 있다.
  → 포괄적이고 중의적인 표현 좋지 않아 !!

 

 

• 변수명에 중요한 세부 정보 덧붙이기

 

사용자가 반드시 알아야하는 변수와 관련된 중요한 정보는 추가적인 단어로 만들어서 이름에 붙이는 게 좋다.

 

ex.

함수	인수 단위를 포함하여 재작성
Start(int delay)	Start(int delay_secs) 초
CreateCache(int size)	CreateCache(int size_mb) 메가바이트
ThrottleDownload(float limit)	ThrottleDownload(float max_kbps) 케이비피에스
Rotate(float angle)	Rotate(float degrees_cw) 정방향(+)

📍 Kbps (Kilobits per second : 1초당 1,000 bits)

데이터 전송 매체가 주어진 시간에 전송할 수 있는 데이터의 양, 주파수 대역을 나타낼 때 쓰는 단위

📍 CW / CCW (Clock Wise : 시계 방향 / Counter Clock Wise : 시계 반대 방향)

시계 방향 === 정방향 / 시계 반대 방향 === 역방향 의 의미로 자주 쓰임

 

ex.

상황	변수명	더 나은 이름
패스워드가 'plaintext'에 담겨 있고, 추가적인 처리를 하기 전에 반드시 암호화되어야 한다.	password	plaintext_password
사용자에게 보여지는 설명문이 화면에 나타나기 전에 이스케이프 처리가 되어야 한다.	comment	unescaped_comment
html 바이트가 UTF-8로 변환되었다.	html	html_utf8
입력데이터가 'url encoded' 되었다.	data	data_urlenc

변수의 단위뿐만 아니라 꼭 명시해야하는 정보가 있다면 나타내주자.

 

 

• 사용 범위가 넓으면 긴 이름을 사용하기

 

여러 페이지에 걸쳐서 사용되는 변수의 이름은 의미를 알아보기 힘들 정도로 짧게 작명하지 마라.

다만 좁은 범위에서 잠깐 사용되는 변수명은 짧을수록 좋다.

 

 

• 대문자나 밑줄 등을 의미있는 방식으로 사용하기

 

문법적 차이가 드러나게 서로 다른 개체의 이름에

각자 다른 포맷팅 방식을 적용하는 방법은 코드를 더 읽기 쉽게 해준다.

→ 언어마다 차이가 있기 때문에, 개발자 재량으로 처리될 듯 하다 :)