반응형 Clean Code13 [클린 코드] 4장 - 주석 (Comments) 이번 포스팅에서는 클린 코드 4장 - 주석에 대해 알아보겠습니다. 코드로 의도를 표현하라! 대부분 주석을 보면 코드로 설명이 다 안 되니까 이해시키려고 달아논 코드입니다. 그러지 말고 코드에 개발자의 의도를 표현하는 방법을 사용하자. 예) // 직원에게 복지 혜택을 받을 자격이 있는지 검사한다. if ((employee.flags & HOURLY_FLAG) && (employee.age > 65)) if 조건이 아주 길고 어렵기 때문에 위에 주석을 달아논 것을 볼 수 있습니다. if (employee.isEligibleForFullBenefits()) 주석을 제거하고 위처럼 의도가 나타나게 코드를 변경하니 주석이 없이도 술술 읽힌다. 좋은 주석 1. 법적인 주석 코드 배포 license를 명시할 때 사용.. 2022. 3. 1. [클린 코드] 3장 - 함수 (Functions) 이번 포스팅에선 클린 코드 3장 함수에 대해서 알아보겠습니다. 3장에서는 함수를 어떻게 하면 클린하게 작성할 수 있는지 소개합니다. 1. 작게 만들어라 가장 중요한 규칙입니다. 작게 만들어라! 얼마나 작아야 작게 만든 걸까? 라는 생각을 맨날 했는데 켄트 벡이 예전에 짠 소스엔 2~4줄이 넘어가는 메소드가 없었다고 합니다. (실무에서 저렇게 해보려고 했는데 잘 안 되더라구요...ㅎㅎ..) if, else, while 등에 들어가는 블록은 1줄이어야 한다. 결론 : 작으면 작을수록 좋다. 2. 한 가지만 해라! 2장에서도 나왔던 내용입니다. 함수는 한 가지만 해야 하고 그걸 잘 해야 한다. 그럼 한 가지만 하는지 어떻게 판단할 수 있을까? 1) 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행하.. 2022. 2. 28. [클린 코드] 2장 - 의미 있는 이름 (Meaningful Names) 이번 포스팅에선 클린 코드 2장 - 의미 있는 이름을 정리해보겠습니다. 매 장마다 정말 중요한 내용들이네요. 의미 있는 이름? 클래스, 인터페이스, 변수, 인자 등 다양한 곳에 개발자가 직접 이름을 붙혀가면서 개발을 하고 있습니다. 수 많은 이름을 붙혀줘야 하는데 고민하기 싫다고 그냥 의미 없는 이름을 붙혀준다면? 바로 나쁜 코드가 발생합니다. 그럼 어떻게 의미 있는 이름을 붙혀야 하는지 하나씩 알아보겠습니다. 의미 있는 이름을 짓는 법 1. 의도를 분명히 밝혀라 의도를 분명히 하는 변수명을 짓는데 고민하는 시간이 아까워도 투자해야 합니다. 그 이름을 짓으므로 절약하는 시간이 더 많기 때문입니다. 예1) int d; // 경과 시간(단위: 날짜) 위처럼 경과 시간을 그냥 d라고 단순하게 줘버리면 무슨 의.. 2022. 2. 27. [클린 코드] 1장 - 깨끗한 코드 (Clean Code) 클린 코드 1장에서는 어떤 코드가 깨끗한 코드인지 왜 깨끗한 코드를 작성해야 하는지 설명하고 있습니다. 나쁜 코드란? 나쁜 코드란 읽기 어려운 코드를 말합니다. 단순히 로직이 복잡해서 읽기 어려운 코드를 말하는 것이 아니라 어떤 의도로 코드가 작성이 됐는지 이해하기 어려운 코드를 말합니다. 개발하시다 보면 누군가가 작성해논 코드를 보고 이게 도대체 무슨 의미인지, 왜 필요한지 알 수 없어 수 차례 읽어봐야 이해가 가는 코드를 보신 적이 있으실 겁니다. 이해해보면 완전 간단한 코드인데 말이죠. 나쁜 코드란 수정하기 어려운 코드를 말합니다. 코드 한 줄만 수정하면 되는 간단한 로직이라고 생각했는데 참조하고 있는 곳이 수십개여서 수정하는데 한참 걸리는 경우를 경험하신 적이 있으신가요? 바로 그겁니다. 나쁜 코.. 2022. 2. 27. 이전 1 2 다음 반응형
