좋은 개발자로 한 걸음

참고

https://www.oracle.com/java/technologies/javase/codeconventions-contents.html

http://kwangshin.pe.kr/blog/java-code-conventions-%EC%9E%90%EB%B0%94-%EC%BD%94%EB%94%A9-%EA%B7%9C%EC%B9%99/

https://naver.github.io/hackday-conventions-java/

를 참고하고 학습하였습니다!

🥐 1. 개요 🥐

Java Code Conventions 이 필요한 이유?

소프트웨어를 개발하는 비용 중 80% 가 유지 보수에 쓰여지는데, 직접 개발한 개발자가 유지보수 까지 담당하는 경우는 극히 드물다.

코딩 규칙을 지키면 다른 개발자가 그 소스를 처음 보았을 때, 더 빠른 시간안에 이해할 수 있도록 하고, 다른 사람들이 작성한 소스와도 잘 어울려진다.

🥐 2. 파일 이름 🥐

.java : 자바 소스
.class : 자바 바이트 코드

🥐 3. 파일 구조 🥐

• 2000 라인 넘는 파일 만들지 말기!
• 빈 줄이나 다른 구역임을 나타내는 주석으로 나누어져 여러 구역으로 구성되어 있음!

🍡 자바 소스 파일

시작 주석, Package 문과 Import 문

• 패키지 명 위에다 시작 주석을 작성한다.
• 패키지 명의 첫번째 레벨은 도메인 이름들 (com, edu, gov, mil, net, org) 중 하나이거나, 영어 두 문자로 표현되는 나라 구별 코드 중 하나여야 한다.

/*
 * 클래스 이름
 *
 * 버전 정보
 *
 * 날짜
 *
 * 저작권 정보
 */
 
 package edu.javaConventions;

 import java.util.*;
	

Class와 Interface 선언

/* 
 * 1) 인터페이스, 클래스 문서화 주석
 * @version  2021년 4월 18일
 * @author   보라비
 *
 */


public class CodeConvention {
	/* 3) 인터페이스, 클래스 구현 주석 * /
	
	public static int var1;

}

순서	구성요소	설명
1	인터페이스, 클래스 문서화 주석	작성한 날짜. 작정한 사람, 버전 같은 클래스에 대한 정보를 기입한다.
2	인터페이스, 클래스 문	클래스 혹은 인터페이스의 시작이 나온다.
3	인터페이스/ 클래스 구현 주석	문서화에 적합하지 않지만 필요한 하나의 클래스, 인터페이스에 대한 해당 정보를 기입한다.
4	static 변수	public -> protected -> none(패키지 접근 제한자가 없는 경우) -> private 순으로 기입한다.
5	일반 변수	작성하는 순서는 클래스 변수와 동일
6	생성자
7	메서드	기능성에 의해서 나눠짐, public 메서드 사이에 private 가 있어도 됨

🥐 4. 들여쓰기 🥐

• 4개의 space를 들여쓰기 단위로 사용
• 탭은 8개의 빈칸으로 설정하는 것이 좋다.
• 한줄에 80자가 넘는 것은 피하자! ( 문서화 주석 같은 경우 70자! )

🍡 줄 나누기

규칙

1. 콤마 후에 2줄로 나눈다.
2. 연산자 앞에서 두줄로 나눈다.
3. 레벨이 낮은 원칙 보다는 레벨이 높은 원칙에 따라 두 줄로 나눈다.
4. 앞 줄과 같은 레벨의 식이 시작되는 새로운 줄은 앞줄과 들여쓰기를 일치시킨다.

🍒 예시 1 : 수학적 표현식에 레벨원칙을 적용한 것

stat.setErrRate((Math.round((stat.getErrCnt() 
			     / (double) (stat.getTotalTrnCnt())) * 100000)) / 1000.0);
        
        

🍒 예시 2 : 일반적인 들어쓰기는 빈칸 8개를 활용하자

vo.stream()
        .forEach(data -> { ... })
        

🍒 예시 3 : 3항 연산자에서 가능한 3 가지 방법

a = (연산식) ? b : c;  
  
a = (연산식) ? b
           : c;  
  
a = (연산식)
    ? b
    : c;

🥐 5. 주석 🥐

• 자바에서 주석은 2가지!
  1) 구현 주석 : 각각의 구현에 대해 추가적인 설명이 필요할 때

/* .. */  
//

• 구현 주석은 각각의 구현에 대한 추가적인 설명이 필요할 때 사용

• 패키지 구조같은 전체적인 코드 흐름에 대한 내용에는 사용하지 않는다.

  2) 문서화 주석 :

  
  /** .. */
  

🍡 구현 주석 종류

🍒 1) 블록 주석 : 수학적 표현식에 레벨원칙을 적용한 것

/*
 *
 */
 
 /*- 
 * 들여쓰기 규칙을 무시해도 되는 특별한 주석

 */

🍒 2) 한 줄 주석 : 한 줄 주석은 빈줄로 시작해야 한다. 길어지면 블록 주석으로 변경하자

if (a == b) {
 
 	/* 이 조건을 만족하면 실행 */
    
}

🍒 3) 꼬리 주석 : 아주 짧은 주석이 필요한 경우 사용, 실제 코드랑 멀리 떨어트려야 한다.

if (a == b) {
 
 	sum = a + b;            /* Explain why here. */          
    
}

🍒 4) 줄의 끝 주석 : 한 줄 씩 적용

if (foo > 1) {

    // Do a double-flip.
    ...
}
else {
    return false;          // Explain why here.
}
//if (bar > 1) {
//
//    // Do a triple-flip.
//    ...
//}
//else {
//    return false;
//}

🥐 6. 선언 🥐

• 한 줄에 하나씩 선언하기! ( int size, level ) 등
• 다른 타입끼리 같이 선언하지 말기! int size, sizeArr [] ; 등

int     level;          // indentation level
int     size;            // size of table
Object  currentEntry;    // currently selected table entry

🍡 초기화

• 지역 변수의 초기화는 선언할 때!
• 초기화 값이 다른 작업에 의해 결정되면 나중에 선언;

🍡 위치 배치

• 지역 변수의 초기화는 선언할 때!
• 초기화 값이 다른 작업에 의해 결정되면 나중에 선언;