클린 코드: 네이밍
Convention의 종류
snake_case: Python, Ruby 등에서 권장
camelCase : Java, Javascript 등에서 권장
PascalCase : 대부분의 프로그래밍 언어에서 클래스를 네이밍할 때 사용
kebab-case: HTML Element를 표현할 때 사용
변수와 상수
변수와 상수를 네이밍 할 때는 명사 혹은 형용사를 사용한다.
user_date = ... #명사
is_valid = ... #형용사함수와 메서드
함수와 매서드를 네이밍할 때는 동사 혹은 형용사 구문 형태를 사용한다.
def send_data():
...
def input_is_valid():
...클래스
클래스 이름을 네이밍할 떄는 명사 구문 형태를 사용한다.
class Client:
...
class RequestBody:
...
네이밍 TIP
구체적, 명시적으로 네이밍을 하고, 불필요한 표현은 제거한다.
#as-is
dt = "20210901KST"
for i in data:
...
#to-be
datetime_with_timezone = "20210901KST"
for product in products:
...#as-is
product_with_price = Product("아이폰", 3000)
the_message = 1 #불필요한 관사 포함
name_string = "grab" #변수명에 타입을 부가적으로 표현함
#to-be
product = Product("아이폰", 3000)
message = 1
name = "grab"
<참고>
'# Development > Methodologies' 카테고리의 다른 글
| [클린 코드] 에러 핸들링 (0) | 2023.01.31 |
|---|---|
| [클린 코드] 클래스 (0) | 2023.01.31 |
| [클린 코드] 함수 (0) | 2023.01.31 |
| [클린 코드] 주석 & 포맷팅 (0) | 2023.01.31 |
