Programming language/Clean Code

[클린코드 작성하기] 네이밍

아네스 2022. 1. 7. 12:17
반응형

Convention 

대표적으로 4가지. 명명된 컨벤션 이름만 봐도 알 수있음.

snake_case : 언더바 형태로 띄워쓰기 표기

camelCase : 낙타의 혹같이 띄워쓰기 표기

PascalCase : 첫글자부터 대문자. 대부분의 프로그래밍 언어에서 클래스를 네이밍할 때 사용

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

 

변수와 상수

 : 동사, 형용사 형태

user_data = ... #명사

is_valid = .. # 형용사

 

함수와 메서드

 : 동사 , 형용사 구문 형태로 지음

send_data() / input_is_valid()

 

클래스

 : 명사, PascalCase

class Client:

 ...

class RequestBody:

 

Tips ( 명시적 ! )

1. 구체적이고 명시적으로 적을 것 ( ex : dt - 암시적 / datetime 명시적 ) - 축약표현은 혼자쓸때 정도.

 : 변수명이 너무 길어지지 않게 적당히

2. 불필요한 표현은 제거. 구체화를 적정선에서만 할 것.

3. 짧고 애매한 표현모다 길고 직관적인 표현이 차라리 낫다.

반응형

'Programming language > Clean Code' 카테고리의 다른 글

[클린코드 작성하기] 주석 & 포맷팅  (0) 2022.01.07