[TIL] 네이밍

convetion

• snake_case : Python, Ruby에서 권장
• camelCase : Java, Javascript에서 권장
• PascaleCase : 대부분의 프로그래밍 언어에서 클래스를 네이밍할 때 사용
• kebab-case : HTML element를 표현할 때 사용

변수와 상수

• 명사 또는 형용사 형태로

user_data = ... 
is_valid = ... 

함수와 메서드

• 동사 혹은 형용사 형태

def send_data():
    ...

def input_is_valid():
    ...
 

클래스

• 명사 형태

class User:
    ...
    
class RequestBody:
    ...

1. 네이밍은 구체적이고 명시적으로 지어야 한다.

전) dt = '20211222KST'
후) datetime_with_timezone = '20211222KST'
--------------------------------------------
전) for i in data : 
    ...
후) for product in products:
    ...

2. 불필요한 표현은 제거한다.

전) product_with_price = Product('아이폰',300)
후) product = Product('아이폰',300)
--------------------------------------------
전) the_message =1 
후) message =1 
--------------------------------------------
전) name_string = 'jake'
후) name = 'jake' 

[참고자료] 모든 개발자의 실무를 위한 필수 기본기 클래스,그랩(인프런 강의)