코딩 컨벤션(coding convention)

코딩 컨벤션을 정리하게 된 계기 👇
: 첫 번째 스터디 변수 챕터 내 관련 내용이 있다는 것이..! 뇌리를 스쳤다

1. 코딩 컨벤션이란 무엇이고 왜 중요할까?

코드를 작성할 때 지켜야 할 일종의 스타일 가이드

• 가독성 향상: 누가 봐도 한눈에 이해하기 쉬움.

• 협업 효율성: 여러 명이 작성해도 하나의 코드처럼 보이게 함.

• 유지보수 용이: 시간이 지나도 고치거나 이해하기 쉬움.

✏️ 이러한 이유로 코드 컨벤션은 꽤나 중요하다!

2. 코딩 컨벤션의 대표적인 항목

- 들여쓰기 (Indentation)

• 보통 2칸 또는 4칸. 팀 규칙에 따름.

- 변수명 / 함수 스타일

• camelCase, snake_case, PascalCase
  ex. userName, get_user_data(), UserProfile

- 줄바꿈 / 공백

• 연산자 앞뒤, 함수 인자 간격, 블록 간 공백 등
  ex. if (a == b) vs if(a==b)

- 주석 스타일

• 한 줄 주석, 블록 주석 사용 기준
  ex. 너무 많은 주석 vs 의미 있는 주석

- 파일 / 클래스 / 함수 구조

• 한 파일에 클래스 하나만, 짧은 함수 단위로 쪼개기 등

이전 발표 때 snake_case에 대해 잘 알지 못하여서 이번에는 snake_case에 대해 보충 설명을 해볼 예정 !

2-1. snake_case란?

: 주로 파이썬(Python)에서 많이 쓰이는 이름 규칙

소문자 단어들을 언더스코어(_)로 구분하는 표기법

• 함수명, 변수명에 사용

def get_user_info():
    user_name = "YJ"
    return user_name

• 모듈명, 파일명에 사용

# 파일 이름 예시
user_controller.py
data_loader.py

❌ 단, 클래스명에는 사용하지 않음!

• 클래스명은 PascalCase를 사용

class UserProfile:

• 다른 언어에서는?
  • Java, JavaScript, C# 등은 대부분 camelCase 선호
  • 하지만 상수(const)는 대문자 snake_case 사용

    const MAX_VALUE = 100;
    

 

3. 코딩 컨벤션을 도와주는 도구들

: 아래 블로그에 도구들이 잘 모아져있어 링크로 첨부한다!

https://blog.naver.com/rinjyu/222458111066