Part 3. 오해할

Part 3

오해할 수 없는 이름들

내가 가장 부족한 것이 이 점이라고 생각한다.

이름을 짓고 나서 누군가가 이 의미를 이해할 수 있느냐 인데,

부족한 점이라고 느끼게 되었다.

책에서는 간편한 단어들을 제시하였다.

조금 더 찾아보며 적어두어야겠다.

-- 번외로 변수명을 지어주는 사이트도 있으니 참고하자.

http://www.curioustore.com/ 

* 경계 값

포함하는 한계값에는 : min, max

포함하는 범위에는 : first, last

배제하는 범위 : begin, end

* Boolean 값

is (isOpaque)

is + 명사 : (무엇)인가 ?

is + 현재진행형 : ~하는 중 인가 ?

is + 형용사 : 수동태의 용어 (hidden, select 등)

has (hasSpaceLeft)

has + 명사 : ~를 가지고 있는가 ?

has + 과거분사 : ~가 유지되고 있는가 ?

can (canRun)

can + 동사원형 : ~할 수 있는가?

should : ~해야 하는가 ?

- 부정하는 용어는 피하도록 하자.

* 친절하게

무언가 계산을 하는 메소드가 있다면

다른 사람은 이 메소드의 속도 또는 연산의 과정을 알지 못한다.

그렇기에 약간의 친절을 배풀어 적어두도록하자.

getData -> computeData (계산하다)

* 의미없는

m_dataPath

o_character

obj_paper

굳이 앞 문장에 m_, o_, obj_ 등의 스스로를 변수라고 알려주는 단어는 불필요하다.

없더라도 충분히 의미를 전달할 수 있다.

---

검색해본 블로그 중 괜찮은 곳을 찾았다.

https://brunch.co.kr/@goodvc78/12

다른 깃허브의 오픈소스를 받아 함수명 네이밍들을 분석한 글이다.

네이밍의 단어 연결 구조

[명사 | 동사 | 형용사] + [명사 + 명사 ...]

---

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

더스틴 보즈웰, 트레버 파우커 지음 - 임백준 옮김

한빛미디어