주석

문지은·2021년 9월 30일
0

clean code

목록 보기
4/10

사실 좋은 주석이란 존재하기 어렵다. 왜냐하면 개발자들은 주석을 유지 보수하지 않기 때문이다. 코드는 변화에 따라 계속 바뀌지만 주석은 바뀌지 않고 주석은 오히려 코드 해석에 방해가 되는 경우가 많다. 따라서 주석을 작성하기보다는 되도록 주석이 필요없도록 코드를 리팩토링하는 편이 낫다.

좋은 주석

// 의도 설명
// FOR UPDATE 구문 때문에 isolation level 변경한다. REPEATABLE_READ는 FOR UPDATE 구문 사용하면 데드롹 발생

// 의미 명료하게
assertTrue(a.compareTo(a) == 0)	// a == a
assertTrue(a.compareTo(b) != 0)	// a != b
assertTrue(b.compareTo(a) == 1)	// b > a

// 결과 경고
// 이 부분 지우면 ~~ 문제 일어난다.

나쁜 주석

// 오해할 수 있는 주석
// 타임 아웃 발생하면 예외를 던진다.
public synchronized void waitForClose(final long timeMillis);
// 타임 아웃이 발생되는 순간 예외를 던지는 것인지 접속시 타임 아웃이 발생하면 예외를 던지는 것인지 알 수 없다.

// 있으나 마나한 주석
// param이 Y이고 i가 소수일 때
if (StringUtils.equals("Y", param) && isPrime(i))

// 주석으로 처리된 코드
// 남들이 섣불리 지우지 못한다.
profile
백엔드 개발자입니다.

0개의 댓글