공부기록/JAVA

자바 명명 규칙(Naming Convention)

또리머 2021. 12. 23. 18:00
반응형


네이밍 규칙은 프로그램을 더 쉽게 파악할 수 있게 해주기 때문에 아주 중요하다.
대개 식별자 타입에 따라 규칙이 나누어져 있다.

짧은 여담: 항상 메소드/메서드 뭐라고 이야기할까 하다가 오늘에서야 결론을 냈다.

ㅎㅎ감사합니다 온라인가나다..!



네이밍 규칙을 살펴보기 전 살펴보면 좋을 글!
파스칼, 카멜 케이스 등 표기법을 정리해놓은 글이다.

2021.12.23 - [공부기록/JAVA] - 표기법 - 스네이크 케이스, 케밥 케이스, 파스칼 케이스, 카멜 케이스

표기법 - 스네이크 케이스, 케밥 케이스, 파스칼 케이스, 카멜 케이스

지난 게시글을 올리다가 문득 표기법에 대해서도 정리해야겠다는 생각이 들었다. 표기법을 헷갈려하던 아찔했던 지난 날들이 생각난다.. (특히 파스칼이랑 카멜이 참 헷갈렸었다 ㅋㅋ) 표기법

ddorimeo.tistory.com


패키지(Packages)

💟전부 소문자 사용을 권장한다.
💟가급적 한 단어의 짧은 이름 사용하기

최 상 위 레 벨 | com, edu, gov, mil, net, org, kr.co 등 가장 높은 레벨의 도메인 이름
이 하 | 협업 단위 내부의 명명 규칙을 따르면 된다.
표 준 패 턴 | com.회사이름.프로젝트명

💟패키지 명명의 예는 다음과 같다.

- com.doorimeo.hello
- com.apple.quicktime.v2



클래스(Clssses)

💟 명사형으로 작성한다.
💟 파스칼 케이스 (PascalCase) 사용
💟 되도록이면 약어 사용하지 말기 ( HTML 등과 같이 통용되는 약어 제외 )

💟 클래스 명명의 예는 다음과 같다.

public class LoginController

또한 클래스 파일의 이름은 클래스 이름과 같아야 한다!



인터페이스(Interfaces)

💟 클래스 이름과 같은 규칙을 적용한다.

💟 인터페이스 명명의 예는 다음과 같다.

public interface CustomListener



메서드(Methods)

💟 동사형으로 작성한다.
💟 카멜 케이스 (camelCase) 사용

💟 메서드 명명의 예는 다음과 같다.

public void setName()
public List<String> getNameList()



변수(Variables)

💟 변수 사용의 의도가 명확하게 작성
💟 카멜 케이스 (camelCase) 사용
💟 임시 변수의 경우 숫자형은 i, j, k, m, n / 문자형은 c, d, e를 사용한다.

💟 변수 명명의 예는 다음과 같다.

int categoryDepth
String menuKeyword

(임시 변수)
int i
char c



상수(Constants)

💟 전부 대문자로 작성하되, 각각의 단어는 '_' (언더바)로 구분한다.

💟 상수 명명의 예는 다음과 같다.

static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;

여기서 잠깐!

그렇다면 아래 코드에서 코드에 빨간 줄이 그어진 이유는..!?


=> 파일명(Test.java)와 클래스명(test)가 다르기 때문이다.

반응형