코딩 스타일 가이드

슬기로운 개발자생활/DevOps

코딩 스타일 가이드

개발자 소신 2024. 1. 5. 08:17

코딩 스타일 가이드는 2인 이상이라면 규모에 상관없이 정하고간다. 2인 팀의 소규모 프로젝트부터 기업과 같이 인원수가 많은 곳 어디든 스타일 가이드는 코드리뷰와 유지보수를 위해 중요하다. 주로 컨벤션이라고 함

스타일가이드

스타일 가이드의 기본적인 의미는 프로젝트를 시작할 때 최종 제품의 시각적 이미지 및 표현을 정의하고 디자인 및 개발 프로세스를 계획하는 데 사용하기 위한 것이다.

코딩 스타일 가이드는 코드의 표현을 정의하는 것이라고 볼 수 있다.

순서

1. 개발 언어 별 변수, 함수, 클래스 네이밍 규칙
2. git flow
3. IT 기업 스타일 가이드
4. 참고자료

1. 개발 언어 별 변수, 함수, 클래스 네이밍 규칙

파이썬 (Python)

# variable
snake_case = True

# constant_variable
UPPER_SNAKE_CASE = True

# function
def snake_case():
    print('or camelCase')

# class
class PascalCase:
    pass

자바스크립트 (Javascript)

문장끝에 세미콜론(;)을 붙이지 않음

// variable
camelCase = true

// constant variable
UPPER_SNAKE_CASE = true

// function
function camelCase(){
  // pass
}

// class
class PascalCase {
  constructor(camelCase){
    this.variable = camelCase;
  }
}

2. git flow

여러 사람과 하나의 깃 레포를 가지고 작업하는 경우 코드를 제어

master : 최종 배포 브랜치
develop : 개발 브랜치
feature : 단위 기능 개발 브랜치 (develop 브랜치로 우선 merge)
release : 배포 브랜치, QA용
hotfix : 크리티컬 오류 해결을 위한 브랜치.

팀에따라 컨벤션은 다르겠지만 경험상 브랜치 이름을 가장 앞에 두고 어떤 기능을 수정했는지 추가적으로 이름을 지어주는게 좋았음 (feature의 경우 front/back도 분리)

feature/front/[function name]
hotfix/[function name]

- commit message

프로젝트 관리 툴(JIRA)를 활용할 경우 1 issue 1 commit을 규칙으로 함
[JIRA ISSUE CODE] COMMIT_TYPE: COMMIT_SUMMARY
COMMIT_TYPE : feat, fix, docs, style, test, refactor, chore
* 커밋타입은 주로 feat, fix, refactor, test 정도 사용
COMMIT_SUMMARY : 영어 50자 이내, 마침표 X

3. IT 기업 스타일가이드

4. 참고자료

저작자표시