클린코드 2

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

주석 모든 내용을 주석으로 넣게되면 코드가 지저분 해짐. 네이밍을 잘하면 충분히 해결 가능 네이밍으로 표현할 수 없는 영역을 주석으로 표현하기 바람. 법적인 정보 담을 때 : Copyright등등.. 의도를 명확하게 설명할 때 : 함수내 알고리즘 설명할 때, 중요성을 강조할 때 결과를 경고할 때 관용적으로 사용되는 키워드 TODO : 당장은 아니지만 다음에 해야할 때 ( TODO@sihyeon : 객체의 책임 더 분리하기 등등 ) FIXME : 치명적인 에러를 발생하는 코드는 아니지만 수정해야할 때 ( 반복문의 depth를 줄이기 ) XXX : 더 생각해볼 필요가 있을 때 포맷팅 Vertical Formatting ( 파일 라인이 길어지는 경우 ) : 한 파일에 코드를 다 넣지 말고, 개념에 맞게 파일을..

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

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. 구체적이고 명시적으..