4장. 주석

의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않다.

주석은 오래될수록 코드에서 멀어지고, 언제나 코드와 정합성이 일치하지 않는다.

따라서 코드를 깔끔하게 정리하여 표현력을 강화함으로써 애초에 주석이 필요 없는 방향으로 에너지를 쏟는 것이 좋다.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

부정확한 주석은 독자를 현혹하고 오더하기 때문. 코드만이 자기가 하는 일을 진실되게 말해준다. 즉 정보를 제공하는 유일한 출처.

따라서 주석을 가능한 줄이도록 꾸준히 노력하자.

주석은 나쁜 코드를 보완하지 못한다.

코드에 주석 추가하는 일반적 이유는 코드 품질이 나쁘기 때문.

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

코드로 의도를 표현하라

많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

주석으로 표현한 코드 예시

// 직원에게 복지 혜택을 받을 자격이 있는지 검사
if ((employee.flags & HOURLY_FLAG) && employee.age > 65) {
    ...
}

코드로 의도를 표현한 예시

if (employee.isEligibleForFullBenefits()) {
    ...
}

좋은 주석

법적인 주석

회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣는 경우

표준 라이센스나 외부 문서를 참조하는 것도 좋음

### 정보를 제공하는 주석

기본적인 정보를 주석으로 제공하면 편리하다. 하지만 가능하면 함수 이름에 정보를 담는 편이 더 낫다.

의도를 설명하는 주석

구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도를 설명하는 경우

의미를 명료하게 밝히는 주석

모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

ex) assertTrue(a.compareTo(a) == 0) // a == a

실제 코드

이런 경우엔 주석으로 표현하니까 훨씬 명쾌해졌었음!

// 카프카 전송 전에 모든 적립건이 실패할 경우 액션 그룹 COMPLETE 처리
return actionMultiService.checkAndCompleteActionGroup(actionGroup.key)

결과를 경고하는 주석

다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용하는 경우

ex) 특정 테스트 케이스가 대량 테스트 데이터를 사용하는 경우 경고.

실제 코드

# application.yml 파일과 다르게 동작함에 주의
# default 설정을 자동으로 적용하지 않는다. (모두 명시해주어야함)

TODO 주석

앞으로 할 일을 TODO 주석으로 남겨두는 경우.

ex) 필요하지만 당장 구현하기 어려운 업무 기술

실제 코드

launch(Dispatchers.IO) { // TODO: 코루틴 스레드 병목 검증 필요. https://kakaopay.agit.in/g/300039265/wall/352972947#comment_panel_354269144
    runCatching {
        val info = objectMapper.readValue(action.info, PointMultiApprovalDTO::class.java)
        ...
    }
}

주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애는 것이 바람직함.

또한 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안됨을 유의하자!

중요성을 강조하는 주석

대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용

공개 API 에서 Javadocs

설명이 잘 된 공개 API 는 매우 유용하다.

나쁜 주석

대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드르 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백

의무적으로 다는 주석

특별한 이유 없이 의무감으로, 혹은 프로세스에서 하라고 해서 마지못해 다는 경우는 시간낭비

주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력하자

같은 이야기를 중복하는 주석

같은 코드 내용을 해석해서 그대로 주석으로 옮겨 두는 경우 -> 코드만 지저분하고 정신 없게 만듬

오해할 여지가 있는 주석

실제로 프로그래머에게 딱 맞게 도움을 주는 주석을 달지 못하는 경우도 존재.

그런 주석에 담긴 '살짝 잘못된 정보' 로 인해 다른 프로그래머로 하여금 오해를 하게 만들 수 있으니 주의하자

이력을 기록하는 주석

예전엔 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 통상적이었음

하지만 소스 코드 관리 시스템이 있으니, 이러한 주석은 삼가자. 단순히 혼란만 가중할 뿐임.

있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석은 나쁜 주석

// 월 중 일자
private val dayOfMonth: Int

무서운 잡음

때로는 Javadocs 도 잡음이다. 단지 문서를 제공해야 한다는 잘못된 욕심으로 인한 결과..

함수나 변수로 표현할 수 있다면 주석을 달지 마라

주석이 사용된 코드

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

주석 대신 함수와 변수로 표현한 코드

val moduleDependees = smodule.getDependSubsystem()
val ourSubsystem = subSysMod.getSubSystem()
if (moduleDependees.contains(ourSubSystem)) {
    ...
}

위치를 표시하는 주석

소스 파일 내에서 특정 위치를 표시하려 주석 사용

// Actions /////////////////

일반적으로 이러한 주석은 가독성만 낮추므로 제거해야 마땅. 특히 뒷 부분에 슬래시로 이어지는 잡음은 반드시 제거

배너는 눈에 띄며 주의를 환기해주는 역할도 있어서, 반드시 필요할 때만 아주 드물게 사용하는게 좋다.

실제 코드

: 인터페이스 내에 이름만으로는 메서드들을 구분하기 어려워서 구분하기 위해 사용했음!

interface ActionCustomRepository {
    // JdbcTemplate
    fun saveAllBulk(actionList: List<Action>)

    // Querydsl
    fun findSuccessActionCountByActionGroupKey(actionGroupKey: String): Int
    ...
}

닫는 괄호에 다는 주석

중첩이 심하고 장황한 함수에는 닫는 괄호 주석이 의미가 있을 수 있겠지만, 애초에 그러한 구조의 함수가 있다면 함수를 줄이려고 하자. -> 작고 캡슐화된 함수에 그러한 주석은 잡음일 뿐

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

이러한 정보는 소스 코드 관리 시스템에 저장하는 것이 좋다. 저자 이름으로 코드를 오염시킬 필요가 없다.

궁금한 점

모듈들 위에 보면 @Author ~ 라고 많이 남기던데, 이런 것들도 지양해야 하는 걸까?!

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기 주저하게 됨 -> 이유가 있어 남겨놓았거나, 중요하니까 지우면 안될거라 생각함.

그러다보면 쓸모 없는 코드가 점차 쌓여간다.

따라서 이 또한 소스 코드 관리 시스템에 맡기면 잃어버릴 염려가 없으니 불필요한 코드는 그냥 삭제해버리자. (커밋하지 않은 주석 코드는 날아가버리긴 할 거 같지만..)

HTML 주석

주석에 HTML 코드는 혐오 그 자체 라고 한다!

전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라!

코드가 변하다 보면 주석과 정합성이 맞지 않게 될 가능성이 있기 때문

너무 많은 정보

주석에 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이에 관계가 명백해야 한다. 이왕 공들여 달아놨다면 적어도 독자가 주석과 코드를 읽고 뭔 소린지 알아야 한다!

주석을 다는 목적은 코드만으로 설명이 부족해서이기 때문이다.

함수 헤더

짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

비공개 코드에서 Javadocs

공개 API 는 Javadocs 가 유용하지만, 공개하지 않을 코드라면 쓸모가 없다.

느낀점

평상 시에 주석이 없을 때 이해하기 조금 어려운 코드가 있을 경우에 주석을 사용했던 것 같다. 이번 챕터를 읽으면서 주석을 어떠한 상황에 사용하면 좋은지, 그리고 어떠한 상황에서는 사용하지 않는 것이 좋은지 알 수 있었다.

사실 예전에 코드 리뷰를 받으면서, 다른 분께서 클린 코드 책을 근거로 내가 작성했던 주석을 지적해 주신 경험이 있다. 그때 말씀해주신 내용을 이해하여 이번 챕터의 내용을 대충은 알고 있었으나, 세세한 부분까지는 몰랐어서 이번 기회에 추가적인 여러 조언들을 확인할 수 있었다 !