[코드 컨벤션] 대표적인 코드 컨벤션 규칙

1. 들여쓰기 (Indentation)

• 규칙 : 코드 블록을 들여쓰기하여 계층 구조를 명확히 한다.
• 일반 규칙
  • 스페이스 또는 탭을 사용한다.
  • 일반적으로는 2개 또는 4개의 스페이스를 사용한다.

// 2 spaces
function example() {
  if (true) {
    console.log('Hello');
  }
}

 

2. 코드 라인 길이 (Line Length)

• 규칙 : 코드 라인의 길이를 제한하여 가독성을 높인다.
• 일반 규칙
  • 보통 80~120자 이내로 제한
  • 긴 표현식은 여러 줄로 나누어 작성

3. 변수 및 함수 (Line Length)

• 규칙 : 일관된 변수 및 함수 이름을 사용하여 코드의 의도를 명확히 한다.
• 일반 규칙
  • PascalCase(파스칼 케이스) : 첫글자와 이어지는 단어의 첫글자를 대문자로 표기하는 방법
    • Pascal 이라는 프로그래밍 언어에서 이러한 표기법을 사용해서 유명해짐
    • ex) GoodPerson, MyKakaoCake, IAmDeveloper
  • camelCase(카멜 케이스) : 첫단어는 소문자이지만, 이어지는 단어의 첫글자는 대문자로 표기
    • ex) goodPerson, myKakaoCake, iAmDeveloper
  • snake_case(스네이크 케이스) : 모든 단어를 소문자로 표기하고, 단어를 언더바(_) 로 연결
    • ex) good_person, my_kakao_cake, i_am_developer
  • kebab-case(케밥 케이스) : 모든 단어를 소문자로 표기하고, 단어를 대시(-) 로 연결
    • 보통 프로그래밍 보다는 파일명이나 폴더명에 사용
    • ex) good-person, my-kakao-cake, i-am-developer
  • UPPER_CASE(어퍼 케이스) : 모든 단어를 대문자로 표기하고, 단어를 언더바(_) 로 연결
    • 상수변수에 주로 사용
    • ex) GOOD_PERSON, MY_KAKAO_CAKE, I_AM_DEVELOPER

4. 주석 (Comments)

• 규칙 : 코드에 주석을 추가하여 코드의 목적과 작동 방식을 설명
• 일반 규칙
  • 주석은 필요할 때만 사용하며, 코드가 명확한 경우에는 과도한 주석을 피합니다.

5. 코드 블록 구분 (Code Block Separation)

• 규칙 : 코드 블록 사이에 빈 줄을 추가하여 코드의 구조를 명확히 한다.
• 일반 규칙
  • 함수나 메서드 사이, 또는 주요 코드 블록 사이에 빈 줄을 추가

def function_one():
    pass

def function_two():
    pass

 

6. 형식 일관성 (Consistent Formatting)

• 규칙 : 일관된 형식을 유지하여 코드의 가독성을 높임
• 일반 규칙
  • 코드의 공백, 중괄호 위치, 괄호 사용 등을 일관되게 유지

// Consistent formatting
function example() {
  const x = 10;
  const y = 20;
  if (x > y) {
    console.log('x is greater than y');
  } else {
    console.log('x is less than or equal to y');
  }
}

 

7. 파일 및 디렉토리 구조 (File and Directory Structure)

• 규칙 : 파일과 디렉토리를 체계적으로 조직
• 일반 규칙
  • 관련 파일을 함께 묶어 디렉토리를 구성
  • 파일 이름은 소문자와 하이픈을 사용하여 구분

8. 오류 처리 (Error Handling)

• 규칙 : 오류를 명확히 처리하고, 적절한 방법으로 오류를 로깅하거나 사용자에게 알림
• 일반 규칙
  • try-catch 구문을 사용하여 예외를 처리
  • 적절한 오류 메시지를 제공하고, 오류 발생 시 적절한 조치를 취하기

9. 파일 내 함수 순서 (Order of Functions)

• 규칙 : 파일 내에서 함수의 순서를 일관되게 유지
• 일반 규칙
  • 일반적으로 상단에 유틸리티 함수나 헬퍼 함수를 배치하고, 주요 함수나 메서드를 그 아래에 배치

10. 모듈화 (Modularity)

• 규칙 : 코드를 모듈화하여 재사용성을 높이고, 각 모듈이 하나의 책임만 가지도록 한다.
• 일반 규칙
  • 기능별로 파일을 분리하고, 각 파일은 하나의 모듈을 정의