클린코드

2023. 9. 14. 20:52개발/토막난 상식

반응형

네이밍

 

snake_case 파이썬 루비

camelCase js

PascalCase 클래스 네이밍

kebab-case html

 

 

변수와 상수

명사 아님 형용사

 

 

함수와 메서드

동사 형용사

 

클래스

명사

 

 

 

 

구체적이고 암시적으로 적을것

dt > datetime

 

 

i 보단 product

i > idx

 

 

 

불필요한 데이터 제거할것

 

관사 제거할것

 

 

타입을 명시할 필요가 없음 꼭 필요한 경우가 아니면

 

 

 

주석 

지저분하지 않게끔 만들기 > 네이밍으로 해결 할것

주로

법적인 내용

의도를 담을때 (쓰레드를 늘린 이유)

중요성 강조 (최종결제전 검증필요!)

결과를 경고할때 > 경고할 내용

 

 

관행적 사용

todo@개발자 - 다음에 할거

fixme - 당장은 아니지만 나중에 고칠떄

xxx - 더 생각해볼 필요가 있을떄

 

 

 

 

 

포메팅

버티컬 - 파일을 나눠서 관리하자 (여러 스토어)

비슷한 개념의 코드는 붙이기 

 

 

데이터

데이터할당 

 

데이터처리 

 

 

 

변수등을 활용해 가독성 높이기 

코드 길이를 관리할것

네이밍도 활용

 

 

 

함수

함수의 역할은 하나만 쓰도록 하자 srp

if not 오류날수 있구 가독성이 떨어짐

 

반복하지 말자  dry

- 양이 많아지고

- 변경이 힘들다

 

드라이드라이

 

 

파라미터수를 적게 유지하자

 

 

사이드 이펙트를 잘 다루자

- 무언가 외부 의존성이 있을시 

업데이트와 셋 이 있으면 이러한 부분을 명시해줄것

 

조회를 분리하자! - 사이드 이펙트가 거의 없다

 

너무 많은 업데이트를 남발하지 말자 

 

 

 

클래스

단일 책임 원칙 srp

하나의 클래스는 하나의 책임

응집도를 높이자- 인스턴스 변수를 최대한 많이 활용하자

변경하기 쉽게 만들자 - 오픈클로즈드

 

 

에러핸들링

> 오류가 발생해도 동작을 하게끔 하는것

오류가 났을시 처리하는 방법

내장된 익셉션 사용하기 

- 로그만 남기지 말고 처리를 하자  > 회사내 채널에 알리기 

애러가 발생해도 실행되야 하는 경우 처리하기

 

 

 

조건문을 많이 쓸수록 인덴트가 발생하게 된다

폴리모피스- if를 하나로 묶어서 잘 관리하자

 

 

 

가장 통상적으로 사용한는 것 - 객체지향

 

절차지향 > 객체지향 > 함수지향

 

정답은없다

 

절차지향 -  함수와 조건문 루푸문을 활용'중앙 집중 - 이해하기 쉽고 빠르다 유지보수도 쉽다 뇌와 비슷하게 작동

함수가 많아지면 데이처 추적 변경이 어렵다

 

 

 

https://velog.io/@majaeh43/%EC%A0%88%EC%B0%A8%EC%A7%80%ED%96%A5-%EA%B0%9D%EC%B2%B4%EC%A7%80%ED%96%A5-%ED%95%A8%EC%88%98%ED%98%95-%ED%94%84%EB%A1%9C%EA%B7%B8%EB%9E%98%EB%B0%8D

 

절차지향 & 객체지향 & 함수형 프로그래밍 ?

절차지향 & 객체지향 & 함수형 프로그래밍 입문!

velog.io

 

 

반응형

'개발 > 토막난 상식' 카테고리의 다른 글

윈도우키 먹통 해결법  (0) 2023.10.17
useEffect 가 바라보는 const {}  (0) 2023.09.20
깃 전략적 활용  (0) 2023.09.14
이미지 전송법  (0) 2023.09.08
이미지 저장위치는 어디에  (0) 2023.09.08