[Java] 클래스, 메서드, 변수에 대한 Naming Rulue

---

클래스 명명 규칙

• 클래스명에는 파스칼을 사용
  • public class HelloWorld {} 

 

• 인터페이스에는 특별한 접두사나 접미사를 사용하지 않고 파스칼을 사용
  • public interface Animal {}

 

• 인터페이스를 구현한 클래스에는 특별한 접두사나 접미사를 사용하지 않고 파스칼을 사용
  
  • public class Tiger implements animal {}

 

• 추상 클래스에는 특별한 접두사 및 접미사를 사용하지 않고 파스칼을 사용한다.
  
  • public abstract class Animal {}

 

---

메서드명

 

• 메서드명에는 파스칼 표기법을 사용한다.
  
  • public void SendMessage( String message ) {}

 

• 속성에 접근하는 메서드명의 접두사는 'get', 'set' 을 사용한다.
  
  • public void setDisplayName
  • public void getDisplayName

 

• 데이터를 조회하는 메서드명의 접두사는 find를 사용한다.
  
  • public void findDate( String data ) {}

 

• 데이터를 입력하는 메서드명의 접두사는 input을 사용한다.
  • public void inputData( HashMap data ) {}

 

• 데이터를 변경하는 메서드명의 접두사는 modify를 사용한다.
  
  • public void modifyData( HashMap data ) {}

 

• 데이터를 삭제하는 메서드명의 접두사는 delete를 사용한다.
  
  • public void deleteData( HashMap data ) {}

 

• 데이터를 초기화 하는 메서드명의 접두사는 initialize을 사용한다.
  
  • public void initData( String data ) {}

 

• 반환값의 타입이 boolean인 메서드는 접두사로 is를 사용한다.
  
  • public void isData( String data ) {}

 

• 데이터를 불러오는 메서드명의 접두사는 load를 사용한다.
  
  • public void loadData() {}

 

• 데이터가 있는지 확인하는 메서드명의 접두사는 has를 사용한다.
  
  • public void hasData() {}

 

• 보다 지능적인 set이 요구될때 사용하는 메서드명의 접두사는 register 사용
  
  • public void registerAccount() {}

 

• 새로운 객체를 만든뒤 해당 객체를 리턴해주는 메서드명의 접두사는 create 사용
  
  • public void createAccount() {}

 

• 해당 객체를 다른 형태의 객체로 변환해주는 메서드명의 접두사는 to를 사용한다.
  
  • public void toString() {}

 

• 해당 객체가 복수인지 단일인지 구분하는 메서드명의 접미사는 s를 사용한다.
  
  • public void getMembers() {}

 

• B를 기준으로 A를 하겠다는 메서드명의 전치사는 By를 사용한다.
  
  • public void getUserByName( String name ) {}

 

---

변수 명명 규칙

 

1. 변수와 메서드의 파라미터에는 카멜표기법을 사용한다.
2. 변수에 약어를 사용하지 않고 모든 의미를 충분히 담는다.
3. 한 글자로 된 이름을 사용하지 않는다.
4. 선언된 지점에서 초기화화며, 가능한 사용범위를 최소화 한다. ( 숫자 0 레퍼런스 null )
5. 반복문에서 인덱스로 사용할 변수는 i, j, k 등으로 사용한다.
6. 지역변수와 멤버변수(전역변수)는 변수명 앞에 밑줄(_)을 사용하여 구분한다.
7. boolean 타입의 변수는 접두사 is를 사용한다. ( isCheck )