변수와 메소드 네이밍 15가지 모범 사례
Source
Evernote/Inbox/변수와 메소드 네이밍에 관한 15가지 모범 사례.md
Summary
이 문서는 코드의 가독성과 유지보수성을 높이기 위한 변수 및 메소드 네이밍의 15가지 모범 사례를 소개합니다. 핵심 원칙은 네이밍의 일관성, 의미 명확성, 그리고 언어별 표준 준수입니다. 구체적으로는 변수의 범위에 따른 적절한 길이 조절, 추상적인 이름(value, data 등) 금지, 헝가리안 노테이션(o_, m_ 등) 배제, ASCII 문자만 사용, 자연어 통일, 메소드명은 동사로 시작하는 의미 있는 이름 사용 등을 강조합니다. 또한 Java를 예시로 들어 클래스(Upper Camel), 변수/메소드(Lower Camel), 상수/Enum 값(Upper Case with underscore) 등에 대한 표준 네이밍 규칙을 제시합니다.
Key Points
- 네이밍의 일관성과 의미 명확성이 코드 품질의 핵심이다.
- 변수명은 저장값을 정확히 설명해야 하며, ‘value’, ‘data’ 등 추상적인 이름은 피한다.
- 변수명 앞에 o_, m_ 등 타입이나 역할을 나타내는 접두사는 사용하지 않는다.
- 변수명의 길이는 범위에 따라 조절한다(루프 카운터: 1글자, 전역변수: 3~4단어 등).
- 프로그래밍 언어의 표준 네이밍 규칙(예: Java의 CamelCase, UpperCase)을 엄격히 따른다.
- 메소드명은 해당 메소드의 동작을 나타내는 동사로 시작하는 의미 있는 이름으로 짓는다.
- 프로젝트 내에서 네이밍 규칙과 사용하는 자연어(예: 영어)를 통일한다.
- ASCII 외 문자 사용은 피하며, 지나치게 긴 변수명(50자 이상)도 지양한다.