Clean Code 2장

Clean code 2장

의미 있는 이름을 짓는 방법

1. 의도를 분명히 밝힌다.

• 흔히 간단하게 선언하는 변수 선언

   int d;
   int tmp = 0;
  

• 위 코드 대신 의도를 분명히 나타내는 단어들을 조합하여 이름을 만들어준다.

2. 그릇된 정보를 피한다.

• 단어의 약어를 마음대로 사용하지 않고 혼용의 요소가 있는지 파악을 한다.
• List라는 특수한 단어는 실제로 리스트 변수가 아니면 사용을 하지 않는다.
• 서로 흡사한 이름을 사용하지 않는다.
• 유사한 개념은 유사한 표기법으로.. 하지만 일관성은 유지하면서 표기한다.

3. 의미있게 구분 한다.

• 변수를 바꿔야 할깨 단순히 뒤에 숫자를 붙이는 방법은 사용하지 않는다.(a1,a2,a3..)=> 변수가 달라지면 의미도 달라져야 한다.
• pinData, pinInfo 와 같이 같은 의미같지만 다른 변수는 사용하지 않는다. (pins 객체와 pinsObject 객체 등 메서드들도 포함)
• 고로 쓸데없이 볼필요한 단어는 이어 붙이지 말자. 붙여서 의미가 달라진다면 예외

4. 발음하기 쉬운 이름을 사용하라.

• 코딩은 사회 활동이다.
• 고로 변수 이름은 다른 사람과 함꼐 교류할때 읽기 좋아야 한다.
• 쓸데없이 여러 단어들을 줄이거나 약자를 이어 붙이지 않고 의미를 나타내는 단어들을 읽기 좋게 붙여야 한다.

5. 검색하기 쉬운 이름을 사용해라.

• 만약 어떤 프로그램에서 최대 나이를 40으로 정해 그냥 코드에 40으로 바로 넣었다면?
• 나중에 최대 나이 수정을 위해 40을 검색했는데 40이라는 숫자가 많다면??
• 이를 방지하기 위해 검색이 쉽도록 다음과 같이 변수를 선언해주면 검색하기 좋으며 의미 파악이 쉽다.

   const int MAX_AGE = 40;
  

6. 인코딩을 피해라.

• 좀 이해하기 힘든 부분이었다. 옛날 방식처럼 변수이름에 타입을 인코딩할 필요가 없다는것 같다.
• 또한 멤버 변수에 접두어를 붙일 필요가 없다는것 같다.
• 또한 인터페이스 클래스와 구현 클래스는 ~FactoryImpl, ~Factory로 인코딩을 해주는게 좋을때가 있다.

7. 기억력에 의존하지 말아야 된다.

• 자신이 아는 이름으로 자기만 아는 단어를 만들어 사용하지 않는다.

8. 클래스 이름

• 클래스 이름은 명사나 명사구로 Manager,data,info 같은 단어는 피해준다.

9. 클래스 이름

• 메서드 이름은 동사나 동사구로 메서드 이름은 인자를 설명하는게 좋다.

10. 기발한 이름은 피해라.

• 만약 농담과 같이 기발한 이름으로 만든다면 그 농담이 기억할때만 그 이름의 의미를 기억할수 있게 된다.
• 의도를 분명하고 솔직하게 진지하게 표현하기

11. 한개념에 한단어를 사용하기.

• 만약 controller라는 단어를 사용하는데 같은 문맥상 의미의 manager,driver 같은 단어를 굳이 사용할 필요가 없다.
• controller를 사용했다면 쭉 일관성 있게 controller만 사용한다.

12. 말장난을 하지 않는다.

• 위에 한개념에 한단어만 사용한다해서 맥락이 다른데 무조건 한 단어만 일관성있게 사용할 필요는 없다.
• 이 내용히 살짝 혼동 될 요소가 있는것 같다. 많이 이름을 만들어 보면서 차차 알아야 겠다.

13. 해법 영억에서 가져온 이름을 사용한다.

• 코드를 읽는 사람은 언제나 프로그래머이기 때문에 알고리즘 이름, 패턴이름등을 사용해도 된다.
• 문제 영역에서 이름을 가져온다면 나중에 모르면 클라이언트에게 물어봐야 한다.

14. 문제 영역에서 가져온 이름을 사용하라.

• 적절한 프로그래머 용어가 없거니 문제 영역과 관련깊은 코드라면 해법 영역 대신 문제 영역에서 단어를 가져와 사용한다.

15. 의미있는 맥락을 추가해야 한다.

• 예를들어 주소와 관련된 것이라면 그 의미를 분명히 하기위해 앞에 Addr를 붙이는게 좋다.

16. 불필요한 맥락을 없애라.

• 위에 의미있는 맥락을 추가해야 한다 해서 중복적인 의미의 맥락들을 넣을 필요는 없다.

2장을 읽고 코드의 가독성을 위해 의미있는 이름이 중요하다는 것도 의미있는 이름 작성법을 배우게 되었다. 내용중에 이렇게 해야하지만 너무 이렇게 하면 안된다 등 일종의 선을 만들어 준것같다. 이 내용들을 지키기 위해서 많은 연습과 고민과 영단어 공부가 필요한것 같다.

맨위로👆

---