[Java] 명명 규칙

smallcherry's techlog·2022년 3월 19일
0

Java

목록 보기
3/10

클래스, 변수, 메소드 등등등 프로그래밍을 하다보면 무언가의 이름을 지을 일이 정말 많다! 물론 잘 알다시피 자바에서 변수명은 _과 $와 숫자, 영어의 조합으로 만들면서 숫자로 시작하지 않으면 되고, 메소드나 다른것들의 이름을 지을 때도 문법적 오류가 나지 않는 선에선 자유롭게 지으면 된다.

이 게시물에서 다루는 건 그런 문법적인 규칙들이 아니라, 쉽게 말해 "통상 이렇게 쓰더라~"다. 이 규칙을 따르지 않는다고 문법적인 오류가 나는건 아니다.

하지만 평생 협업도 안하면서 간단한 소스파일 한 두개만 쓰는 작업할게 아니라면, 알아 두는 게 본인에게도, 협업자에게도 좋을 것 이다.

이름 어떻게 지을 지 고민할 사람들을 위해! 정리해보겠다.

1. 공통

나만의 줄임말은 가급적 만들지 말고 풀네임을 써주자! -numberOfStudent를 nos이런식으로 줄이지 말자! - 어차피 이름에는 길이 제한이 없다. 의미를 단박에 알 수 있게 하는게 가장 중요하다.
=> 2022의 나: 실제로 기업에서 개발할때는 절대 full naming은 불가능! 단어 중 자음이라든지 발음 잘되는것들 4~5글자단위로 줄여서 camel case로 이어붙이는 게 보통이다

2. 변수 (Variable)

변수명은 카멜표기법으로 작성하는 것이 일반적이다. 카멜표기법이란 첫 글자는 소문자지만, 띄어쓰기를 할 부분에서 첫글자를 대문자로 표기하는 방법이다. 임시 정수 변수는 i, j, k, n, m을 사용하는 것이 일반적이고, 임시 문자 변수는 c, d, e를 사용하는 것이 일반적이다.

int numberOfStudent = 30;
String studentName = "Cherry";
int i;
char c;

3. 상수 (Constant)

final 예약어를 통해 선언하여 프로그램 내에서 그 값을 변경할 수 없는 상수다. 상수이름은 일반적으로 대문자와 '_'(underscore)기호를 조합하여 표기한다.

final int MAX_STUDENT_NUM = 50;
final double PI = 3.141592;

4. 메소드 (Method)

메소드 이름은 변수와 명명규칙이 같다. 맨 앞글자는 소문자로 시작하면서 띄어쓰기가 필요한 부분은 대문자를 사용하는 것이다. 사용하는 단어는 가급적 동사를 사용하도록 한다.

String getName (...) {...}
void setBackGround (...) {...}

5. 클래스 (Class)

클래스 이름은 첫 글자를 대문자로 하고, 띄어쓰는 부분도 대문자로 한다. 아래와 같다.

public class Student {...}
private class ImageView {...}

6. 인터페이스 (Interface)

인터페이스도 클래스와 마찬가지로 첫글자를 대문자로 하고, 단어의 구분을 대문자로 해준다.

Interface View;
Interface ScreenController;

7. 패키지 (Package)

영소문자를 사용하며 필요에 따라 숫자도 사용한다. 최상위 패키지는 com, edu, gov, mil, net, org, 또는 1981년 ISO Standard 316에 명시된 영어 두 문자로 표현되는 나라 구별 코드가 사용된다. 하위 패키지는 조직내규를 따른다.

kr.co.cherry
com.pg.example
profile
Java Developer

0개의 댓글