Convention

팀 프로젝트의 꽃은 "협업" 이라고 생각합니다.

팀 프로젝트를 진행함에 있어 중요한 부분 중 하나인 컨벤션에 대해 기존 프로젝트경험을 바탕으로 정리해보겠습니다.

Code convention

📖 Naming

• 패키지 이름 : 소문자

package com.navercorp.apigateway

• 클래스, 인터페이스 이름 : 대문자 Camel case

public class MemberChatroom;

• 메소드 이름 : 소문자 Camel case

findMember()

📌 카멜 표기법

프로그래밍에서 파일, 변수, 함수 등 대상의 이름을 띄어쓰기 없이 짓기 위해 따르는 네이밍컨벤션의 하나.
단어 전체적으로 소문자를 사용하지만, 맨 첫글자를 제외한 각 합성어의 첫 글자만 대문자로 표기.

📖 중괄호

• K&R 스타일 or BSD 스타일

# K&R 스타일

public class Friends {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "block_id")
    private Long id;
}

# BSD 스타일

public class Friends 
{
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "block_id")
    private Long id;
}

📖 들여쓰기

1 tab = 4 space

📖 그 외

팀원이 노션에 공유한 글 및 아래 링크를 참고.

링크 : convention

◼ 참고자료

• 위키백과