[클린 코드] TIL(Today I Learned) DAY 6~7

soleil_lucy·2024년 2월 1일
0

TIL (2024.01.30~02.01)

DAY 6~7

  • 오늘 읽은 범위: 4장 주석

Summary

  • 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않다
  • 주석은 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 사용한다
  • 주석이 필요한 상황에는 코드로 의도를 표현할 방법은 없을까? 하고 질문해보자

책에서 기억하고 싶은 내용

4장 주석

  • 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라
  • 주석을 사용하는 이유?
    • 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용함
  • 주석 === 실패?
    • 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용하기 때문
  • 주석이 필요한 상황에 처할 때, 해야 할 질문?!
    • 코드로 의도를 표현할 방법은 없을까?

  • 주석을 쓰지 말아야 할 이유?
    • 주석은 오래될수록 코드에서 멀어지기 때문에
    • 오래될수록 완전히 그릇될 가능성도 커지기 때문에
    • 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하기 때문에

  • 주석을 쓰지 말고 코드로 표현해야 하는 이유? (코드 >>>>>> 주석)
    • 코드만이 자기가 하는 일을 진실되게 말한다
    • 코드만이 정확한 정보를 제공하는 유일한 출처다

주석은 나쁜 코드를 보완하지 못한다

  • 코드에 주석을 추가하는 일반적인 이유?
    • 코드 품질이 나쁘기 때문

코드로 의도를 표현하라!

  • 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다

주석

  • 법적인 주석
    • 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시하는 경우
  • 정보를 제공하는 주석
    • 기본적인 정보를 주석으로 제공하는 경우
      // 테스트 중인 Responder 인스턴스를 반환한다.
      responderInstance();
  • 의도를 설명하는 주석
    • 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명하는 경우
  • 의미를 명료하게 밝히는 주석
    • 인수나 반환값이 표준라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 경우
  • 결과를 경고하는 주석
    • 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용하는 경우
      public static SimpleDateFormat makStandardHttpDateFormat() {
          // SimpleDateFormat은 스레드에 안전하지 못하다
          // 따라서 각 인스턴스를 독립적으로 생성해야 한다
          SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
          return df;
      }
  • TODO 주석
    • 앞으로 할 일을 //TODO 주석으로 남겨두면 편하다
    • 당장 구현하기 어려운 업무를 기술, 주의 등
  • 중요성을 강조하는 주석
    • 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다
  • 공개 API에서 Javadocs
    • 설명이 잘 된 공개 API(Ex. Javadocs)

나쁜 주석

  • 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다
  • 나쁜 주석의 종류
    • 주절거리는 주석
    • 같은 이야기를 중복하는 주석
    • 오해할 여지가 있는 주석
    • 의무적으로 다는 주석
    • 이력을 기록하는 주석
      • 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가하는 경우
    • 있으나 마나 한 주석
      • 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
    • 무서운 잡음
    • 함수나 변수로 표현할 수 있다면 주석을 달지 마라
      • 주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다
    • 위치를 표시하는 주석
    • 닫는 괄호에 다는 주석
      • 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자
    • 전역 정보
      • 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라
    • 너무 많은 정보
    • 모호한 관계
      • 주석과 주석이 설명하는 코드는 둘 사이 과나계가 명백해야 한다
    • 함수 헤더
      • 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다
    • 비공개 코드에서 Javadocs

오늘 읽은 소감

주석을 완벽하게 관리할 것이 아니라면 코드로 표현할 수 있도록 고민하자. 주석을 달기 전에 항상 코드로 의도를 표현할 방법은 없을까? 라고 질문해보는 습관을 들이자.

나의 최애 북틸

  • Dosjung 님의 TIL 3장. 함수
    • TIL 링크
    • 선정 이유?
      • 책에서 기억하고 싶은 내용에서 page를 적을 생각은 못했는데 나중에 TIL을 다시 볼 때 유용할 것 같다고 생각했습니다. 배울 점이 있는 TIL이라고 생각해서 선정하게 됐습니다.
  • h1335 님의 TIL 3장. 함수
    • TIL 링크
    • 선정 이유?
      • 읽은 후 소감에서 반성을 자세하게 작성한 부분에서 나도 좀 더 저렇게 구체적으로 반성을 하는 게 좋을 것 같다고 배우게 돼서 선정하게 됐습니다.
  • kiyeol 님의 [Clean Code] TIL 3장. 함수
    • TIL 링크
    • 선정 이유?
      • TIL 3줄 요약을 적는 방식이 내가 쓰는 개발 포스트의 Summary를 쓰는 것과 비슷하여 끌려서 선정하게 됐습니다.
profile
여행과 책을 좋아하는 개발자입니다.

0개의 댓글

관련 채용 정보

Powered by GraphCDN, the GraphQL CDN