변수 명명 규칙 요약

이 글은 Code Complete 2의 11장. 변수 이름 효과에서 내 맘에 드는 부분만 요약한 것이다.

문제 지향성

• 기억하기 쉬운 이름은 일반적으로 해결책보다 문제에 대해서 말한다.
• 직원의 데이터에 대한 레코드는 inputRec보다 employeeData가 좋은 이름이다.
• 프린터의 상태 비트 필드는 bitFlag보다 printerReady가 좋은 이름이다.

최적의 이름 길이

• 10~16 또는 8~20
• 코드를 봤을 때, 짧은 이름을 많이 보게 된다면, 이름이 분명한지 확인해 보야야 한다는 것이다.

변수 이름에서의 계산값 한정자

• Total, Sum, Average, Max, Min, Record, String, Pointer같은 값을 보관하는 변수는 이름 끝에 한정자를 입력한다.
  예) revenueTotal, expenseAverage
• Num 대신에 Index나 Count를 사용한다.
  예) customerCount, customerIndex

변수 이름의 일반적인 반의어들

• begin/end
• first/last
• locked/unlocked
• min/max
• next/previous
• old/new
• opened/closed
• visible/invisible
• source/target
• source/destination
• up/down

불린 변수 명명

• done
• error
• found
• success
• ok

명명 규약 샘플

• ClassName
• TypeName
• EnumeratedTypes
• localVariable
• routineParameter
• RoutineName()
• m_ClassVariable
• g_GlobalVariable
• CONSTANT
• MACRO
• Base_EnumeratedType