[Clean Code] 4장. 주석

Clean Code 4장 (주석)

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

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
• 주석은 좋은 주석이 있고, 나쁜 주석이 있다.

좋은 주석 (책에 있는내용 전부 말고, 내 생각에 괜찮다고 생각한 주석들)

• 법적인 주석
  • // Copyright (C) 2003,2004,2005 ... Inc. All rights reserved
• 정보를 제공하는 주석
  • 정규표현식에 대한 주석은 외계어를 알아보기 더 좋게 만들어준다.

    // kk:mm:ss EEE, MMM dd, yyyy 형식이다.
    Pattern timeMatcher = Patern.compile("\\d*:\\d*:\\d*\\w*, \\w* \\d*, \\d*");

• 결과를 경고하는 주석 (아무 생각 없이 호출했다가는 큰일날 함수들은 미리 말해주는것이 좋다.)

  // 여유 시간이 충분하지 않다면 실행하지 마십시요
  public void _testWithReallyBigFile()
  {
      writeLineToFile(10000000);
      ...
  }

나쁜 주석

• 있으나 마나 한 주석(이런걸 쓸 시간에 코드를 정리하는것이 훨씬 낫다.)

  /*
  기본 생성자
  */
  protected AnnualDateRule()
  {
  
  }
  
  /* 월 중 일자를 반환 */
  public int getDayOfMonth()
  {
    return datOfMonth;
  }

• 주석으로 처리한 코드(지우는것이 좋다)

  InputStream response = new InputStreamResponse();
  //InputStream response = new InputStreamResponse2();

  • 코드가 중요한것인지 아닌지 판단하기도 힘들뿐더러 보기도 좋지 않다.

• 공로를 돌리거나 저자를 표시하는 주석(ㅋㅋㅋㅋ)

  /* 릭이 추가함*/

  • ?? ㅋㅋㅋ 하는 사람이 있나 싶지만 조심하자...

여기서 우리 프로젝트에 적용할점은?

• 주석을 달지 않아도 알 수 있을만큼 명확하게 코딩하자. (1~3장 참조)
• 같이 스터디를 했기에 주석을 무조건 달지 않아도 의도를 최대한 표현하려고 했다는 생각을 알고있음.