17장 냄새와 휴리스틱(368~378)

<aside> 💡 마틴 파울러 : 다양한 ‘코드 냄새’가 존재한다

</aside>

주석

<aside> 💡 부적절한 정보의 주석

</aside>

1. 다른 시스템에 저정할 정보는 주석으로 적절하지 못 하다
2. 변경 이력은 장황한 날짜와 따분한 내용으로 소스 코드만 번잡하게 만든다

→ 작성자, 최종수정일, SPR(Software Problem Report) 번호와 같은 메타 정보만 주석으로 남기자

<aside> 💡 쓸모 없는 주석, 주석 처리된 코드

</aside>

→ 오래된 주석, 엉뚱한 주석, 잘못된 주석은 과감히 지우자

→ 주석 처리된 코드는 그냥 지워라 (필요하다면 형상관리시스템이 기억해준다)

<aside> 💡 중복된 주석

</aside>

다음과 같은 함수 서명만 달랑 기술하는 Javadoc은 의미가 없다.

/**
* @param sellResult
* @return
* @throws ManagedComponentException
*/

→ 주석은 코드가 다 하지 못한 설명을 부언한다

환경

1. 한 단계로 빌드해야한다