4장 주석 (이어서)

<aside> 💡 나쁜 주석 : 대다수 주석은 허술한 코드를 지탱하고, 엉성한 코드를 변명할 뿐이다

</aside>

5 함수나 변수로 표현 가능한 주석

다음은 주석을 없애고 표현 가능한 경우다

// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))

ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

6 닫는 괄호에 다는 주석

닫는 괄호에 주석을 달아야할 필요가 잆다면 함수를 줄이려 시도하자

7 공로를 돌리거나 저자를 표시하는 주석

소스 코드 관리시스템의 등장으로 이와 같은 주석은 모두 삭제해야한다!

8 주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기 주저한다

9 전역 정보

주석을 달아야 한다면, 근처에 있는 코드만 기술하라

아래 함수는 포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장이 없다