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

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

- 분량을 줄이기 보다 이해하기 좋게 만들기

- 표면적 수준: 좋은 이름을 짓고, 좋은 설명을 달고, 코드를 보기 좋게 정렬

 

2. 이름에 정보 담기.

- 특정한 단어 고르기

- 보편적인 이름 피하기 (언제 그런 이름을 사용해야 하는지 깨닫기)

- 추상적인 이름 대신 구체적인 이름

- 접두사 or 접미사로 이름에 추가적인 정보 덧붙이기

- 이름이 얼마나 길어져도 좋을지 결정

- 추가적인 정보를 담을 수 있게 이름 구성

 

📌 무의미한 단어 피하기

getPage -> FetchPage/ DownloadPage

Stop -> Kill(최초동작시)/ Pause(다시 돌아간다면)

 

📌 보편적인 이름 사용하는 경우

* tmp

tmp = right
right = left
left = tmp

-> 이 경우엔 'tmp'가 적절함. (임시저장소 역할)

 

📌단위를 포함하는 값들

Start(int delay) -> delay_secs

CreateCashe(int size) -> size_mb

ThrottleDownload(float limit) -> max_kbps

Rotate(float angle) -> degrees_cw

 

📌 루프 반복자

- 중첩문일 경우 i, k, j 보다

 -> clubs[ci], members[mi], users[ui]가 더 명확함.

 

📌 속성 포함하기

- 패스워드가 'plaintext'에 담겨 있고 추가적인 처리 전에 반드시 암호화 되어야 한다.

 = 변수명 password -> plaintext_password

- html의 바이트가 UTF-8로 변환

 = html -> html_utf8

 

📌 이름은 얼마나 길어야 하는가?

- 좁은 범위에서는 짧은 이름이 괜찮다.

- 축약보단 구체적으로, 하지만 eval(evaluation), doc(document), str(string) 이런 약어는 흔해서 괜찮음.

 

📌 이름 포맷팅 의미 전달

예) 클래스 멤버를 로컬 변수와 구분하기 위해 뒤에 '_'를 붙인다. 

 

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

읽기 좋은 코드가 좋은 코드다 - 예스24