item51
항상 표준 명명 규칙을 따라야 한다. 이해할 수 있고, 같은 패키지에 속한 다른 이름들과 일관되게 짓는 게 최우선 목표다. 그 다음으로는 자바 라이브러리의 API 가이드를 참조해서 짓자. 너무 긴 이름은 피하자.
이름 | 컨벤션 | 예시 |
---|---|---|
패키지 | 소문자 | member |
클래스 | 파스칼케이스 | MemberController |
인터페이스 | 파스칼케이스 | MemberService |
함수 | 카멜케이스 | getMember(long id) |
변수 | 카멜케이스 | Member member = .. |
상수 | 대문자 | MEMBER_PWD_REDEX |
모든 메서드는 각각 자신의 소임을 다해야 한다. 메서드가 너무 많은 클래스는 익히고, 사용하고, 문서화하고, 테스트하고, 유지보수하기 어렵다. 클래스나 인터페이스는 자신의 각 기능을 완벽히 수행하는 메서드로 제공해야 한다. 아주 자주 쓰일 경우에만 별도의 약칭 메서드를 두고, 확신이 서지 않으면 만들지 말자.
4개 이하가 좋다. 일단 4개가 넘어가면 매개변수를 전부 기억하기가 쉽지 않다.
같은 타입의 매개변수 여러 개가 연달아 나오는 경우가 특히 해롭다.
(시작 인덱스, 끝 인덱스, 찾을 원소)
총 3가지의 매개변수가 필요하지만 List 에서는 subList
와 indexOf
두개의 메서드로 나누어져 있어 두 메서드를 조합해서 사용하면 된다.