클린 코드(네이밍)

코딩을 하면서 이름을 지을 때 대표적인 컨벤션으로 snake_case , camelCase , pascalCase , kebab-case 4가지가 있습니다.

snake_case: Python, Ruby 등에서 권장함

camelCase : Java, Javascript 등에서 권장함

PascalCase : 대부분의 프로그래밍 언어에서 클래스를 네이밍할 때 사용함

kebab-case: HTML Element를 표현할 때 사용함.

변수와 상수

일반적으로 변수와 상수를 네이밍할 때는 명사 혹은 형용사 구문 형태로 짓습니다.

user_data = ... #명사
is_valid = ... #형용사

함수와 메서드

일반적으로 함수와 메서드를 네이밍할 때는 동사 혹은 형용사 구문 형태로 짓습니다.

function sendData(){
    ...
}
function inputIsValid(){
    ...
}

클래스

일반적으로 클래스 이름을 네이밍할 때는 명사 구문 형태로 짓습니다.

class Client{
    ...
}
class RequestBody{
    ...
}

Tips

1. 명시적으로 적을 것

// as-is
dt = "20210901KST"
for(let i in data){
  ...
}

// to-be
datetime_with_timezone = "20210901KST"
for(let product in products){
  ...
}

dt가 어떠한 의미인지 알 수 없다. 좀더 명시적으로 작성하자

1. 애매한 관사 및 표현 제거

// as-is
product_with_price = Product("아이폰", 3000)
the_message = 1 // 불필요한 관사 포함
name_string = "grab" // 변수명에 타입을 부가적으로 표현함

// to-be
product = Product("아이폰", 3000) 
message = 1
name = "grab"