백엔드 코드 컨벤션

☑️ 코드 컨벤션

<aside> <img src="https://cdn-icons-png.flaticon.com/512/7350/7350737.png" alt="https://cdn-icons-png.flaticon.com/512/7350/7350737.png" width="40px" /> 문자열을 처리할 때는 쌍따옴표를 사용하도록 합니다.

</aside>

</aside>

<aside> 📦 패키지는 소문자로 작성합니다. _ 및 대문자를 함께 쓰지 않습니다.

// Bad
package.com.navercorp.apiGateway
package.com.navercorp.api_gateway

// Good
package.com.navercorp.apigateway

</aside>

<aside> 🖌️ 클래스, 인터페이스는 파스칼 케이스로 작성합니다.

// Bad
public class reservation
public class Accesstoken

// Good
public class Reservation
public class AccessToken

</aside>

<aside> 🔤 클래스 이름은 명사나 명사절로 짓습니다.

</aside>

<aside> 🧩 인터페이스 이름은 명사나 명사절 또는 형용사나 형용사절로 짓습니다.

// Good
public interface RowMapper {
public interface AutoClosable {

</aside>

<aside> 🐫 함수명, 변수명은 카멜케이스로 작성합니다.

</aside>

<aside> 🔤 클래스 첫 줄과 끝 줄에 빈 줄 만들기

class Test {

	private int _a;
	...

}

</aside>

<aside> ☝ 가독성을 위해 한 줄에 하나의 문장만 작성합니다.

// Bad
int base, weight;

// Good
int level; // indentation level
int size; // size of table

</aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> 주석은 설명하려는 구문에 맞춰 들여쓰기 합니다.

// Good
function someFunction() {
  ...

  // statement에 관한 주석
  statements
}

</aside>

<aside> 💬 주석의 전후에는 공백을 삽입합니다. // 앞, // 뒤, /* 뒤, */ 앞

/*
 * 공백 후 주석내용 시작
 */

System.out.print(true); // 주석 기호 앞 뒤로 공백

/* 주석내용 앞에 공백, 뒤에도 공백 */

</aside>

<aside> 💬 콤마 다음에 값이 올 경우 공백을 추가하여 가독성을 높입니다.

var arr = [1,2,3,4]; //bad
var arr = [1, 2, 3, 4]; //good

</aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3978/3978575.png" alt="https://cdn-icons-png.flaticon.com/512/3978/3978575.png" width="40px" /> 연산자 사이에는 공백을 추가하여 가독성을 높입니다.

a+b+c+d // bad
a + b + c + d // good

</aside>

<aside> 🔠 생성자 함수명의 맨 앞글자는 대문자로 합니다.

function Person(){}

</aside>

<aside> 🗨️ 메소드는 동사로 시작합니다. 다른 타입으로 변환하는 메소드는 전치사로 시작할 수 있습니다.

// Good
동사 사용 : renderHtml()
변환 메소드의 전치사 : toString()

</aside>

<aside> 🔢 상수는 대문자로 합니다. 합성어는 _ 를 사용하여 단어를 구분합니다.

// Good
public final int UNLIMITED = -1;
public final String POSTAL_CODE_EXPRESSION = "POST";

</aside>

<aside> 📖 변수명은 가독성 있게 설정합니다. 임시 변수 외에는 1글자 변수명 사용 금지. 이해하기 쉬운 변수명으로 작성합니다.

// Bad
HtmlParser p = new HtmlParser();

// Good
HtmlParser parser = new HtmlParser();

</aside>

<aside> 📝 클래스 import 시에는 와일드카드 * 없이 필요한 클래스 명을 명시적으로 작성합니다.

// Bad - 성능에 영향을 줄 수 있음
import java.util.*;

// Good
import java.util.List;
import java.util.ArrayList;;

</aside>

<aside> 🧦 배열은 복수형 이름을 사용합니다.

// Bad
int[] number = new int[5];

// Good
int[] numbers = new int[5];

</aside>