[주석] 한 일보다는 이유를...

회사 팀장은 소스코드에 주석이 많으면 잘 짠 코드라고 생각하고 주석을 권장한다. (오늘 회의 시간에도 변수마다 일일이 주석을 달라고 한다. 차라리 'int i = ... // 사용자 ID' 를 'int userID = ...' 과 같이 의미있는 이름을 부여해주는 게 나은데..)

하지만 소프트웨어공학 관련 도서를 읽어보면 주석 보다는 코드를 통해 프로그램을 설명하는 프로그래밍을 하라고 조언한다.

이런 것은 프로그래밍 코드 내의 주석 뿐만 아니라 소스코드저장소의 commit log, 에러코드 등에도 적용할 수 있음을 알게 되었다.

지문 장치에 대한 삭제를 만들고 있는데, 특정 사용자가 없을 경우는 에러가 나도록 요구사항에 되어 있었다.

그런데 에러코드가 어떻게 들어오나 확인을 하고 있었는데 통합테스트가 실패했다.

나는 사용자가 없으므로 NoUser라는 에러가 반환할 줄 알았는데, 기기에서는 DeletionError 코드를 반환했던 것이 실패의 원인이었다. 당연히 Delete 메소드를 호출하는데 false가 반환되면 실패인 걸 아는데 구지 '삭제가 실패했다'를 에러코드로 알려줄 필요가 있을까? 이것은 명백히 DRY 위반이다.

실패를 한 이유를 알려줘야 개발자던 사용자던 원인을 알고 대책을 새울 수 있기 때문이다.