Java 컨벤션에 대해서 알아보자 #25
Comments
들어가며프로그래밍을 배우겠다고 처음으로 책을 피고 나면, 빠르게 코드를 어떻게 작성하는 지를 배웠던 것 같다. 내가 배웠던 코드 컨벤션
프로그래밍에서 사용하는 보통은 프로그래밍에서 이 그렇다면 왜 이에 대한 답은 저명한 기업인
파파고 선생님의 해석으로는 다음과 같은 뜻이라고 하신다.
정리하자면 내가 만든 소프트웨어(코드)는 오랫동안 유지 보수가 되어야 하는데, 내가 평생 유지 보수할 일은 거의 없다. 그러니까 다른 사람이 잘 읽고, 해석할 수 있도록 코드를 작성해야 한다는 것이다. 그 다음은
위의 내용에선 조금 더 직관적으로 표현해주었다. 개발자끼리 '어떤 방식으로 코드를 짜자!'는 규칙을 정하면 코드를 작성할 때 고민을 줄일 수 있을 것이고, 마찬가지로 코드를 해석하는데도 쉬울 것이다. 이 상황을 조금이라도 피할 수 있을지도..? 정리하자면
Java Convention 정리
이것만은 제발 피하자!다음 주어지는 케이스들은 나는 개인적으로 아래 짤과 같은 경우라고 생각한다. Class와 Interface의 이름엔 대문자로 시작하자.예시public class MemberServiceImpl{}
public interface MemberService{}Bad Casepublic class memberServiceImpl{} // BAD! 첫 글자는 대문자!
public interface Memberservice{} // BAD! 구분자도 대문자!패키지 이름은 소문자로 구성예시import java.util.Calander; // goodBad Caseimport COM.SSAFY.BOARD.BoardDto; // BAD! 대문자 X
import com.ssafy.application-service.MemberService; // BAD! - X메서드 이름에 소문자 카멜표기법 적용예시public static void main(String[]args){}BAD CASEpublic void SetMember(){} // BAD! 첫 글자는 소문자!
public void getmember(){} // BAD! 구분자는 대문자!상수는 대문자와 언더스코어로 구성예시private static final String EXAMPLE_CODE = "hello";
private static final int MOD = 1_000_000_007;Bad Caseprivate static final String ExampleCode = "hello"; // Bad! 구분자로 _를 입력해야 함
private static final int mod = 1_000_000_007; // Bad! 전체를 대문자로 작성해야 함변수에 소문자 카멜표기법 적용예시String name = "Kim";
int age = 20;
MemberDto memberDto = null;Bad CaseString Name = "Kang"; // BAD! 첫 글자는 소문자 사용!
MemberDto memberdto = null; // Bad! 구분자는 대문자 사용!나는 굉장히 관대한 개발자니까 이정도만 하고 넘어가겠다. 자주 접한 오류세종대왕 컨벤션예시public class 좌표{
int 엑스좌표;
int 와이좌표;
}Good Case(식별자에는 영문/숫자/언더스코어만 허용해야 한다.)public class Coordinate{
int x;
int y;
}한 줄에 여러 문장 쓰기예시int min = Integer.MAX_VALUE; int max = Integer.MIN_VALUE;Good Case (한 줄에는 한 문장만 사용한다)int min = Integer.MAX_VALUE;
int max = Integer.MIN_VALUE;하나의 선언문에 여러 변수 넣기예시int min, max;Good Case (하나의 선언문에는 하나의 변수만)int min;
int max;배열에서 대괄호를 변수 뒤에 선언예시String commands[];Good Case (배열에서 대괄호는 타입 뒤에 선언)String[] commands;한 줄로 끝나는 조건/반복문에 중괄호 사용 X예시if(true)
System.out.println("hello");
else
System.out.println("bye");
while(true)
System.out.println("hello world?");Good Case (조건/반복문에 중괄호 필수 사용)if(true) {
System.out.println("hello");
} else {
System.out.println("bye");
}
while(true) {
System.out.println("hello world?");
}마치며사실 위에서 작성한 케이스정도만 지켜준다면 목숨이 위험한 경우는 없을 것이다. 그래도 이건 내가 관대한 개발자니까 그렇지, 예민한 누군가에겐 이 또한 킬각일지도 모른다. 그렇다면 이 험난한 개발세상에서 살아남기 위해선 이 것들을 다 외워야 하나?? 아니다. 같은 코드조차 두 번 쓰기 귀찮아하는 훌륭한 개발자라면, 당연하게 도구를 이용해서 컨벤션을 적용시킬 수 있다! 어떻게 하는지는 링크를 참고해서 적용하자. 적용하는 법까지 요구하는 것은 물에 빠진 사람 구해줬더니 보따리 내놓으라는 격이다. 다들 컨벤션을 잘 지키며 안전하게 코딩하자. PS. 혹시라도 위에 예시 코드 중에서 컨벤션에 맞지 않는 경우가 있다면 이는 컨벤션 자동 적용의 중요성을 알리기 위한 이스터에그이다. REF네이버 캠퍼스 핵데이 Java 코딩 컨벤션 |
👍 문제
Java의 컨벤션이 무엇이 있는지 알아봅니다.
그리고 어떠한 규칙들이 있는지 적어주면 좋을 것 같아요!
24장에서 "기본적인 애플리케이션 코딩은 잘 되어 있는가?"중 "명명 규칙을 잘 지켰는가?"가 있습니다.
현재 싸피에서 교육을 받고 있는데 강의에서도 그렇고 같은 동기들을 봐도 재대로 명명 규칙을 사용하지 않는 것 같습니다.
그래서 우리라도 재대로 알고 사용해보자는 의도로 문제를 선정하게 되었습니다!
📺 관련 챕터 및 레퍼런스
ch24. 애플리케이션에서 점검해야 할 대상들
🐳 비고
The text was updated successfully, but these errors were encountered: