코딩을 하면서 함수, 변수, 패키지 등등 모든 곳에 이름을 직접 붙인다. 이렇듯 이름을 많이 사용하므로 잘 지어야한다.
의도를 분명하게 밝혀라
주석이 필요하지 않을 정도로 변수, 함수, 클래스명을 작성해야한다.
ex) int d -> int elapsed time in days
그릇된 정보를 피하라
ex) 개발자에게 List는 특수한 의미이다. 그래서 실제로 List가 아니면 AccountList같은 변수명을 명명하지 않는다.
또한 소문자 o와 l은 조심해서 사용하자. 각각 0과 1로 보일 수 있기 때문에 혼란을 줄 수 있다.
의미 있게 구분하라
이상한 변수 사용하지 않기
ex) a1, a2, a3 ...
불용어 붙이지 않기
ex) the, a, an, ~s, ~es 등등
발음하기 쉬운 이름을 사용하라
발음하기 쉬워야 사람들에게 친숙하게 보인다.
검색하기 쉬운 이름을 사용하라
상수로 설정해놓으면 무슨 의미인지 모를 수 있다.
ex) sum/ 5 ->
int StudentNumber = 5
sum/ StudentNumber
인코딩을 피하라
헝가리식 표기법
변수명에 변수타입을 적지말자
멤버 변수 접두어
멤버 변수 접두어는 필요없다.
ex) m_dsc -> description
자신의 기억력을 자랑하지 마라
내코드를 보는 다른 사용자가 한번 더 생각해야할 변수를 짓지 말자
ex) URL -> r 로 사용하지 말자
클래스 이름, 메서드 이름
클래스 이름은 명사나 명사구를 사용하고 메서드 이름은 동사나 동사구를 사용한다.
말장난을 하지 마라
한 단어를 두가지 목적으로 사용하지 마라
ex) append, insert를 add라는 1개의 단어로 사용하지 말자
의미 있는 맥락을 추가하라
함수안에 여러 코드가 있다면 좋은 맥락으로 표현하자.
내 코드로 비교해보기
백준 1932 문제이다.
1. k라는 변수가 있는데 무슨 의미인지 모른다.
2. k = 2라고 되어 있는데 왜 2인지 설명이 필요함
3. i와 j의 정확한 의미가 필요한 것 같다.