이번에 주석에 대해 설명해준다.
저자는 주석은 필요없다고 한다. 그 이유는 주석을 유지하고 보수하기란 현실적으로 불가능하다고 생각하기 때문이다. 코드만이 정확한 정보를 제공하는 유일한 출처다.
그래서 우리는 주석을 가능한 줄이도록 꾸준히 노력해야한다.
📌 주석은 나쁜 코드를 보완하지 못한다.
코드에 주석을 추가하는 일반 적인 이유는 코드 품질이 나쁘기 때문이다.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
📌 코드로 의도를 표현하라
확실히 코드만으로 의도를 설명하기 어려운 경우가 존재하지만 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다. 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
📌 좋은 주석
어떤 주석은 필요하거나 유익하다.
법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
정보를 제공하는 주석
기본적인 정보를 주석으로 제공하면 편리하다.
의도를 설명하는 주석
때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 까린 의도까지 설명한다.
의미를 명료하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
일반적으로 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
결과를 경고하는 주석
때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
TODO 주석
때로는 앞으로 할일을 TODO 주석으로 남겨두면 편하다
중요성을 강조하는 주석
자칫 대수롭지 않다고 여겨질 뭔가를 중요성을 강조하기 위해서도 주석을 사용한다
📌 나쁜 주석
대다수 주석이 이 범주에 속한다.
주절거리는 주석
특별한 이유없이 의무감으로 마지못해 주석을 단다면 전적으로 시간 낭비다.
주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
같은 이야기를 중복하는 주석
헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다면 코드보다 주석읽는 시간이 더 오래 걸릴 수 있다.
오해할 여지가 있는 주석
때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도한다.
의무적으로 다는 주석
모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만든다.
이력을 기록하는 주석
때때로 사람들은 모듈 편집할때마다 모듈첫머리에 주석을 추가한다. 완전히 제거하는 편이 좋다.
있으나 마나 한 주석
때때로 있으나 마나 한 주석을 접한다. 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
함수나 변수로 표현할 수 있다면 주석을 달지마라
주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다
닫는 괄호에 다는 주석
닫는 괄호에 특수한 주석을 달아놓는 경우가 있는데 작고 캡슐화된 함수에는 잡음일 뿐이다.
주석으로 처리한 코드
주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
HTML 주석
HTML주석은 혐오 그 자체다
전역 정보
주석을 달아야한다면 근처에 있는 코드만 기술하라 코드 일부에주석을 달면서 시스템의 전반적인 정보를 기수랗지 마라
너무 많은 정보
관련 없는 정보를 장황하게 늘어놓지 마라
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야한다.
함수 헤더
짧은 함수는 긴 설명이 필요 없다. 짧고 한가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
주석이 안좋다는건 알고 있었지만 사실 마음 한구석에는 주석이 있으면 이해하기 쉽지 않나 라는 생각을 가지고 있었다. 하지만 이장을 읽으면서 필요 없는 주석은 없애야겠다고 생각이 들었다.
