[JAVA] 프로그래밍 네이밍 규칙

자바를 기준으로 작성, 대표적으로 사용되는건 아래 4가지 표기법이 존재한다

 

• 파스칼 표기법(PascalCase) : 모든단어의 첫번째 문자는 대문자이며 나머지는 소문자
• 카멜 표기법(CamelCase) : 첫번째 단어는 소문자이며 두번째 단어부터 첫번째는 대문자 나머지 소문자
• 헝가리안 표기법(Hungarian Notiation) : 접두어에 자료형을 알아볼 수 있게 표기
• 스네이크 표기법(Snake Case) : 단어 사이에 _를 사용해 표기

 

• 패키지 : 전부 소문자 
• 클래스 : 단어 첫글자 대문자
• 메서드 : 첫번째 단어 소문자, 두번째 부터 대문자
• 변수 : 표기법에 따라 다름
• 상수 : 전부 대문자로 작성하되, 단어와 단어 사이는 _(언더바)를 사용해 구분

#네이밍 예시

 

패키지 : 전부 소문자 

com.example.demo
com.example.demo.controller
com.example.demo.mapper
com.example.demo.entity
com.example.demo.service

클래스 : 파스칼 표기법

public class BoardController{}
public class Membercontroller{}

public class BoardVO{}
public class MemberVO{}

public class BoardService{}
public class MemberService{}

public interface BoardMapper{}
public interface MemberMapper{}

메서드 : 카멜 표기법

public List<BoardVO> selectBoard()
public int insertBoard(BoardVO boardVO)
public int updateBoard(BoardVO boardVO)
public int deleteBoard(BoardVO boardVO)
public BoardVO viewBoard(BoardVO boardVO)
public List<BoardVO> searchBoard(String keyword)

변수 : 표기법에 따라 달라짐

String MemberName = "A";    //파스칼
String memberName = "A";    //카멜
String StrMemberName = "A"; //헝가리안
String member_name = "A";   //스네이크

List<String> MemberList = new ArrayList<>();    //파스칼
List<String> memberList = new ArrayList<>();    //카멜
List<String> ArrMemberList = new ArrayList<>(); //헝가리안
List<String> member_list = new ArrayList<>();   //스네이크

상수 : 전부 대문자, 단어와 단어사이는 _로 구분

private static final String UPLOAD_PATH = "/images/";
private static final int LOGIN_COUNT = 3;

 

개발현장마다 변수명 규칙도 다르니 그때그때 달라지기도 하며

개발환경에 따라서도 달라지기도 한다

 

자바의 경우 카멜 표기법(memberList)가 표준이지만

PostgreSQL의 경우 대소문자를 구분하기 때문에 대문자 단어는 ""로 감싸줘야 인식하기 때문에

카멜표기법을 사용하면 코딩이 길어진다

이 경우에는 스네이크 표기법(member_list)를 사용하기도 한다