[클린 코드] 2장 의미 있는 이름

TIL (Today I Learned)

22.02.20

오늘 읽은 범위

2장 의미 있는 이름

책에서 기억하고 싶은 내용

- 의도를 분명히 밝혀라 : 이름은 변수/함수/클래스의 존재 이유, 수행 기능, 사용 방법을 모두 나타내야 한다.

- 변수 이름에 의미가 불명확한 불용어를 추가하는 것은 좋지 않다.

ex) Product -> ProductInfo, ProductData

- 범위 길이가 길수록 이름을 정확하고 길게 지어야 한다.

- 클래스 이름 : 명사나 명사구 / 메서드 이름 : 동사나 동사구

- 맥락을 부여하고 함수를 쪼개라.

 

- 사람들이 이름을 바꾸지 않으려는 이유 중 하나는 다른 개발자가 반대할까 두려워서다. 그러나 우리들 생각은 다르다. 오히려 좋은 이름으로 바꿔주면 반갑고 고맙다.

 

오늘 읽은 소감

- 변수 이름에 의미가 불명확한 불용어를 추가하는 것은 좋지 않다.

ProductInfo 처럼 뒤에 Info같은 이름을 붙이곤 했는데 저게 불분명한 방식이라는 것을 알게 됐다. 앞으로는 좀 더 의미가 명확한 단어를 사용해 맥락을 부여해야겠다. 

 

- 의도를 분명히 밝혀라

for (int[] cell : gameBoard)
	if (cell[0] == 4)
    		flaggedCells.add(cell)

 원래는 위 코드처럼 0번째 값을 주로 사용하고 있었는데, 아래처럼 (1) 0값을 해당 값의 의미로 바꿔주거나 (2) 간단한 클래스를 이용해 비교할 수 있다는 것을 알게 됐다! 앞으로 이 방법은 자주 쓸 수 있을 것 같다.

for (Cell cell : gameBoard)
	// (1)
    	if (cell[STATUS_VALUE] == FLAGGED)
    		flaggedCells.add(cell)
	// (2)
	if (cell.isFlagged())
    		flaggedCells.add(cell)

 

궁금하거나 잘 이해되지 않는 내용

- 불용어(stop word) : 문장을 구성하는 필수 요소지만 문맥적으로 큰 의미가 없는 단어