1 minute read

이번엔 JAVA 에서의 네이밍 규칙에 대해서 알아보고자 합니다.
아마 프로그래밍을 배운지 얼마 안되신 분들은 네이밍이 왜 중요하지 그냥 대충 지어서 하면 되는거 아닌가 하고 생각하실 수도 있다고 생각합니다 저 또한 그랬거든요
하지만 프로그래밍에서 네이밍은 굉장히 중요합니다. 그에 대한 이유는 여러가지가 있는데 대표적으로 이름만 잘 지어놔도 해당 클래스, 메소드, 변수가 어떤 작업을 위해 존재하는지 파악하기가 쉬워 남들이 작성한 코드를 볼 때 한결 더 이해하기가 쉽고 반대로 내가 작성한 코드를 다른 사람이 이해하기도 쉬워지니 일의 능률이 증가합니다. 그래서 네이밍이 굉장히 중요하다고 볼 수 있고 오늘은 JAVA 에서 지정한 네이밍 규칙에 대해서 알아보도록 하겠으며, 이후에 이 포트스틀 참고하셔서 본인의 코드에도 적용해 보시길 바랍니다.

1. 클래스 이름 짓기

  1. 클래스명은 명사를 사용해야 합니다.
  2. 클래스명은 대문자로 시작해야 합니다.
  3. 여러 개의 단어를 조합하여 만들 경우 각 단어의 첫 번째 글자는 대문자를 사용해야 합니다. 이를 파스칼 케이스(pascal case) 라고 합니다.

규칙에 따른 클래스명의 예시는 다음과 같습니다.

class Cookie {}
class ChocoCookie {}

2. 메소드 이름 짓기

  1. 메소드명은 동사를 사용합니다.
  2. 메소드명은 소문자로 시작합니다.
  3. 여러 개의 단어를 조합하여 만들 경우 맨 첫 글자를 제외한 나머지 단어의 첫 글자는 대문자를 사용하여 구분합니다. 이를 카멜 케이스(camel case) 라고 합니다.

규칙에 따른 메소드명의 예시는 다음과 같습니다.

run();
runFast();
getBackground();

변수 이름 짓기

  1. 변수 이름은 짧지만 의미가 있어야 합니다. 즉 변수명만 봐도 사용한 이유를 알 수 있게 지어야 합니다.
  2. 순서를 의미하고 임시로 쓰이는 정수의 변수명은 i, j, k, m, n 을 사용합니다. 문자의 경우는 c, d, e 등을 사용합니다.
  3. 변수명에 _, $ 를 쓸 수 있지만 시작 문자로 사용하는 것은 지양해야 합니다.

규칙에 따른 변수명의 예시는 다음과 같습니다.

String userName;
float lineWidth;
int i; // 주로 반복문에서 사용
char c; // 주로 반복문에서 사용

이번엔 JAVA 의 네이밍 규칙에 대해서 알아보았습니다. 이번에 제가 소개 드린 내용은 기본적인 규칙이며, 같이 프로젝트를 하는 구성원과 논의해서 새로운 규칙을 만들어서 적용해도 괜찮습니다.
그리고 네이밍 규칙은 지켜지면 좋지만 무조건 지켜야 하는 것은 아니긴 합니다 그래도 지켰을 때의 효과가 크니 지키는 것을 추천드립니다.
프로그래밍을 배울 때는 보통 혼자 코딩을 많이 하니 이런 규칙에 대해서 크게 신경쓰시는 분이 적을 거라고 생각합니다. 저는 저도 그랬고 같이 프로그래밍을 공부하던 친구들도 그랬기 때문에요 하지만 회사에 들어가시게 되면 이런 네이밍 규칙들을 많이 접하시게 될거고 어떤 곳은 굉장히 깐깐하게 볼 것으로 생각됩니다. 그래서 저는 프로그래밍을 배울 때부터 스스로 이런 규칙을 배우고 만들고 해서 엄격하게 지키고자 하는 자세를 습득한다면 아주 많은 도움이 될 것으로 생각되네요 이번에도 포스트 읽어주셔서 감사하고 궁금하신 내용이나 오타가 있다면 댓글 남겨주시기 바랍니다!

참조

https://wikidocs.net/1936

Tags:

Categories:

Updated:

Comments