더북(TheBook)

코드를 약간만 바꾸었을 뿐인데 녹색 텍스트가 거의 사라졌습니다.

먼저 코드 한 줄만 읽으면 바로 알 수 있는 주석은 모두 제거했습니다. 코드 블록의 끝을 표시하는 주석(End IFEnd FOR 등)도 모두 없앴습니다. 들여쓰기로 이미 알 수 있는데도 불구하고 레거시 코드나 잘 알려진 라이브러리에서 이러한 주석이 놀랄 정도로 자주 보입니다.

클래스 구조(필드와 메서드, 반환)를 강조하는 주석도 모두 제거했습니다. 자바 코드 규칙에서 정한 클래스 구조에 따르면 이러한 종류의 이정표는 넣을 필요가 없습니다.

다음으로 contaminatedCounter++; // 카운터를 증가시킨다처럼 코드를 바꾸어 설명하는 주석도 모두 제거했습니다. 코드에 뭔가를 덧붙여 설명하지 않는 주석은 아무 의미가 없습니다.

TODO 주석을 수정하는 대신 nullisEmpty() 검증도 추가했습니다. TODO를 수정할 수 없을 때는 수정될 때까지 문제를 논의하고 추적할 수 있는 이슈 트래커에 이슈를 생성하세요.

남은 주석은 코드만 보아서는 드러나지 않는 정보가 들어간 주석뿐입니다. suppliesnull이거나 비었으면 0을 반환하는 온화한 지속(graceful continuation) 방법을 선택했습니다. 온화한 지속 방법 대신 예외를 발생시키는 방법을 선택할 수도 있었기 때문에 주석을 넣을 이유가 충분합니다. 이 부분은 디자인 결정을 설명했다고 볼 수 있습니다.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.