Develop
의미 있는 이름
transfer_kk
2023. 2. 16. 17:33
의미 있는 이름
- 의도를 분명히 밝히기 - 의도를 분명히 하는 변수명을 짓는 것이 오래걸려도 그 이름을 지어 절약하는 시간이 더 많기 때문
- 그릇된 정보를 피하자 - 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용하지 말자 (최대한 약어 피하기)
- List와 Collection 구분 - 변수명에 List를 넣으려면 진짜 타입이 List인 경우에만 넣고 Collection인 경우 s를 붙혀준다.
- 있는 사람이 차이를 알도록 의미 있게 구분하자 ex) productInfo vs productData => 어떤 차이가 있는지 알기 힘듬- 변수명에 타입을 넣지 말자
- 클래스 이름은 명사나 명사구가 적합하다
- 메서드 이름은 동사나 동사구가 적합하다.
- 한 개념에 한 단어를 사용하라 ex) get fetch retrieve 다 가져오는 메서드지만 한개로 통일해서 써야 읽기 편함
- add, insert, append 처럼 같아보이지만 서로 다른 단어 구분하기
- 해법 영역에서 가져온 이름을 사용하라
- 도메인 영역에서 가져온 이름을 사용하라
- 의미가 불분명한 매직 넘버(설명 없이 등장하는 상)를 상수로 선언하라
네이밍시 중요한 고려 사항
- 왜 존재해야하는가- 무슨 작업을 하는가- 어떻게 사용하는가
참고한 사이트 : https://effortguy.tistory.com/185