의미있는 객체 이름 붙이기

1. 길어도 상관없다. 의도를 분명히 밝힌다.

   어떤 것으로 어떤 일을 하고 어떤 결과를 내는 것인지 처럼 최대한 의도를 밝힌다.

   일반적으로 변수 이름의 길이가 평균 10~16일 때 프로그램을 디버깅하기 위해서 들이는 노력을 최소화 할 수 있고,
   변수의 평균 길이가 8~20인 프로그램은 디버깅하기가 쉽다

 

2. 헷갈리게 하지 않는다.

    정말 리스트의 뜻이 아니라면, List와 같은 단어를 접두어에 붙여서 헷갈리게 하지 않는다.

    약어를 쓰지 않는다.

 

 

3. 불용어를 쓰지 않는다.

    a, an, Info, Data, the, 단순한 숫자 추가 등을 하지 않는다.

 

 

4. 발음 하기 쉬운 단어를 사용한다.

     코드를 보는 사람이 술술 읽히는 코드를 작성하기 위해 노력한다.

 

 

5. 한 개념에 한 단어를 사용하라.

    한 클래스에서 요소를 추가하는 메소드를 ~add() 라고 했다면

     다른 모든 클래스에도 추가하는 메소드는 ~add로 통일시킨다.

 

 

6. 도메인에서 가져온 단어를 사용한다.

    적절한 단어가 없다면 도메인의 단어를 사용한다.

 

 

 

7. 계산된 값을 가지는 변수는 이름의 끝에 한정자를 붙인다.

Ex) TOTAL, SUM, SUB, MAX, MIN, AVERAGE, STRING ...

-> socreAverage (o)

-> averageScore (x)

 

 

8. 프로시져 메소드의 이름은 동사 + 명사 의 형태를 가진다.

    출력한다던가, 더한다던가, 체크한다던가 하는 것은 동사 + 객체 의 형태로 작성한다.

    Ex) PrintScore(), CheckInput() ...

 

 

9. boolean 변수도 그 참/거짓이 무엇을 나타내는지 표현한다.

Ex) 작업을 나타낸다면 done

      성공/실패라면 success

 

 

참고 : remotty.github.io/blog/2014/03/01/hyogwajeogin-ireumjisgi/

클래스/메소드/변수 명명 규칙 : m.blog.naver.com/reona7140/221306141987