개발언어/클린코드 (4) 썸네일형 리스트형 Clean code 5장. 형식 맞추기 5장 형식 맞추기 원활한 소통을 하기 위해 코드의 형식을 맞춘다. 아래 요약된 모든 것의 목적은 다른사람이 내가 작성한 코드를 잘 이해하기 위해서이다. 형식을 맞추는 목적 원활한 소통을 장려 코드 형식은? 적절한 행 길이를 유지 200줄인 파일로도 커다란 시스템을 구축 할 수 있음 신문 기사처럼 작성해라 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다. 개념은 빈행으로 분리해라 패키지 선언부, import 문, 각 함수사이에 빈 행이 들어감. 세로 밀집도 세로 밀집도는 연.. Clean Code 4장. 주석 4장 주석 작성된 코드로 의도를 파악하는 것이 좋다. 과하고 의무적으로 다는 주석들은 나쁜 주석들이다. 주석은 나쁜 코드를 보완하지 못한다. 코드로 의도를 표현하라 if((employee.flags & HOURLY_FALG) 보단 if (employee.isEligibleForFullBenefits()) 좋은 주석 법적인 주석 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고 타당 정보를 제공하는 주석 의도를 설명하는 주석 의미를 명료하게 밝히는 주석 일반적으로는 인수나 반환값 자체를 명확하게 만들면 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용 결과를 경고하는 주석 //SimpleDateFormat 은 스레드.. Clean Code 3장. 함수 3장 함수 함수는 작고 한가지 동작만 하게 만드는 편이 좋다. 코드에서 명령과 조회는 분리하고 위에서 아래로 이야기처럼 읽히게 작성하자. 작게 만들어라 중첩 구조가 생길만큼 함수가 커져서는 안된다. 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다. 한 가지만 해라 함수는 한 가지를 해야 한다. 그 한가지를 잘 해야 한다. 그 한 가지만을 해야 한다. 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 함수 당 추상화 수준은 하나로 위에서 아래로 코드 읽기 : 내려가기 규칙 코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. switch문 스위치문을 추상 팩토리에 꽁꽁 숨겨 아무에게도 보여주지 않는다. 팩토리.. Clean Code 2장. 의미있는 이름 2장 의미있는 이름 의미있는 이름을 붙여라 클래스와 객체 이름은 명사구로, 메소드 이름은 동사구가 적합하다. 또한, 한 개념에 한 단어를 사용하자. 의도를 분명히 밝혀라 그릇된 정보를 피하라 코드에 코드 의미를 흐릴 수 있는 그릇된 단서를 남겨선 안된다. 예로 숫자 1과 소문자 L 구분 / 숫자 0과 대문자 O 구분은 어렵다. 의미있게 구분하라 연속된 숫자를 덧붙이거나 noise word를 추가하는 방식은 적절하지 못하다. 발음하기 쉬운 이름을 사용하라 genymdhms(generate date, year,month, day,hour,minute,second)와 같은 이름을 피하라 검색하기 쉬운 이름을 사용하라 문자 하나를 사용하는 이름과 상수는 텍스트 코드에서 쉽게 눈에 띄지 않는다. e라는 문자는 변.. 이전 1 다음
