반응형 Java/[Clean Code]3 [Clean Code] 3. 주석 주석은 코드만으로는 부족한 설명을 덧붙이기 위해 작성한다. 그러나 우리는 주석으로 코드를 설명하기보다는 코드 자체에 의미를 담아야 한다. 주석이 필요 없는 코드가 가장 좋겠지만, 주석 중에서도 좋은 주석과 나쁜 주석의 종류에 대해 알아보자. 주석의 의미 주석은 순수하게 선하지 못하다. 기껏해야 필요악이다. 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 수 있다면 주석은 전혀 필요하지 않을 것이다. 우리는 코드로 의도를 표현하지 못해서, 실패를 만회하기 위해 주석을 사용하므로 주석은 언제나 실패를 의미한다. 주석은 오래될수록 코드에서 멀어진다. 프로그래머들이 주석을 유지 보수하기는 어렵기 때문이다. 코드가 변화하고 진화하면서 주석은 여기저기로 옮겨지기도, 갈라지고 합쳐지기도 하면서 코드를 따라가지 못한다.. 2021. 9. 2. [Clean Code] 2. 함수 길이가 길고 중복이 많으며 괴상한 문자열과 낯설고 모호한 자료 유형 및 API로 이루어진 코드는 쉽게 이해하기 어렵다. 메서드 몇 개를 추출하고 이름 몇 개를 변경하고 구조를 조금 바꾸면 훨씬 이해하기 쉬운 코드가 된다. 이번 포스트에서는 함수를 잘 짜는 법에 대해 알아볼 것이다. 읽고 이해하기 쉬운 함수 만들기 다양한 규칙을 통해 길고 복잡한 함수를 짧고 이해하기 쉬운 함수로 만들어보자. 함수를 작게 만들어라 함수가 작을수록 더 좋다는 증거나 자료를 제시하기는 어렵지만 작은 함수가 좋다고 확신한다. 함수는 재사용 측면뿐 아니라 가독성 측면에서도 작은 단위로 나누는 것이 좋다. 그럼 함수는 얼마나 짧아야 할까? 일반적으로 함수가 한 화면을 넘어가면 안 된다. 요즘은 화면이 크기 때문에 글자가 많이 들어갈.. 2021. 8. 24. [Clean Code] 1. 의미 있는 이름 개발자 대다수는 자신이 짠 클래스 이름과 메서드 이름을 모두 기억하지 못한다. 문장처럼 읽히는 코드 또는 표나 자료구조처럼 읽히는 코드를 짜는 데만 집중해야 마땅하다. 의미 있는 이름을 짓는 규칙을 적용하면 가독성이 높아지며, 단기적인 효과는 물론 장기적인 이익도 보장한다. 소프트웨어에서 의미 있는 이름을 지어야 하는 이유 변수, 함수, 인수, 클래스, 패키지 등 우리는 모든 곳에 이름을 붙인다. 따라서 이름을 잘 지으면 편리하다. 좋은 이름을 지으려면 시간이 걸릴지 모르지만 좋은 이름으로 절약하는 시간이 훨씬 크다. 이름을 주의하여 지으면 자신은 물론이고 코드를 읽는 사람이 좀 더 행복해질 것이다. 의미 있는 이름을 짓는 규칙들을 알아보자. 1. 의도가 분명한 이름을 지어라 2. 그릇된 정보를 남기지 .. 2021. 8. 5. 이전 1 다음 반응형
