TIL (Today I Learned)
2024.03.07
🔖 오늘 읽은 범위
4장. 주석
💡 책에서 기억하고 싶은 내용
"나쁜 코드에 주석을 달지 마라. 새로 짜라"
잘 달린 주석은 그 어떤 정보보다 유용하다.
경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.
주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다.
이유는 단순하다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.
진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다.
코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!
코드로 의도를 표현하라!
확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다.
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다. if (employee.flags && HOURLY_FLAG) && (employee.age > 65))if (employee.isEligibleForFullBenefits())
몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
좋은 주석
어떤 주석은 필요하거나 유익하다. 지금부터 글자 값을 한다고 생각하는 주석 몇 가지를 소개한다. 하지만 명심하기 바란다. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!
1. 법적인 주석
회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 마땅하다.// Copyright (C) 2003,2004,2005 by Object Mentor, Inc, All rights reserved. // GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.
2. 정보를 제공하는 주석
기본적인 정보를 주석으로 제공하면 편리하다.
// kk:mm:ss EEE, MMM, dd, yyyy 형식이다. Pattern timeMAtcher = Pattern.complie("\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");위에 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다.
이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔하겠다.
그러면 주석이 필요 없어진다.
3. 의도를 설명하는 주석
주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
// 옳은 유형이므로 정렬 순위가 더 높다. // 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
4. 의미를 명료하게 밝히는 주석
모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
5. 결과를 경고하는 주석
다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
6. TODO 주석
'앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다.
함수를 구현하지 않은 이유와 미래 모습을 주석으로 설명
// TODO-MdM 현재 필요하지 않다. // 체크아웃 모델을 도입하면 함수가 필요 없다.
TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
더이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.
그래도 TODO로 떡칠한 코드는 바람직하지 않다. 그러므로 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라고 권한다.
7. 중요성을 강조하는 주석
자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.
8. 공개 API에서 Javadocs
설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.
표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다.
여느 주석과 마찬가지로 Javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.
나쁜 주석
대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
1. 주절거리는 주석
주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.
2. 같은 이야기를 중복하는 주석
간단한 함수로, 헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다.
코드보다 주석을 읽는 시간이 더 오래 걸린다.// this.closed가 true일 때 반환되는 유틸리티 메서드다. // 타임아웃에 도달하면 예외를 던진다.
3. 오해할 여지가 있는 주석
의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.
4. 의무적으로 다는 주석
모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.
이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
5. 이력을 기록하는 주석
사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다.
예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다.
당시에는 소스 코드 관리 시스템이 없었으니까.
하지만 이제는 혼란만 가중할 뿐이다. 완전히 제거하는 편이 좋다.
6. 있으나 마나 한 주석
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
// 기본 생성자
있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.
더 낫고, 행복한 프로그래머가 되는 지름길이다.
7. 무서운 잡음
떄로는 Javadocs도 잡음이다.
함수나 변수로 표현할 수 있다면 주석을 달지 마라
8. 위치를 표시하는 주석
소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
9. 닫는 괄호에 다는 주석
프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다.
중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다.
그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.
10. 공로를 돌리거나 저자를 표시하는 주석
아래와 같은 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
/* 릭이 추가함 */
11. 주석으로 처리한 코드
주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
12. HTML 주석
소스 코드에서 HTML 주석은 혐오 그 자체다.
HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야한다.
13. 전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라.
코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
14. 너무 많은 정보
주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
15. 모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
16. 함수 헤더
짧은 함수는 긴 설명이 필요 없다.
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
17. 비공개 코드에서 Javadocs
첫 번째 주석이 중복이라고 주장하기 쉽다.
그래도 나는 주석이 있어 알고리즘을 이해하기 쉬워진다고 생각한다.
그래서 남겨 두는 편을 택했다.
두 번째 주석은 거의 확실히 필요하다.
변수 이름을 바꾸거나 코드 구조를 조정해 이유를 명확하게 설명할 방법을 찾지 못했다.
✏️ 오늘 읽은 소감
나쁜 주석을 설명하는 글이 좋은 주석을 설명하는 글보다 더 길고 많은 만큼 현업에서도 나쁜 주석을 더 많이 경험해본 것 같다. 책에서도 대다수 주석이 이 범주에 속한다고 할 정도니까 말이다.
처음에 개발할 때는 주석이 길게 달려있는 것을 보면 '우와- 이 개발자 친절하다..'라고 생각했지만 ㅎㅎ..
코드를 보는 눈이 생기고 나서는 주석을 읽는 것이 오히려 에너지 소모가 들었기 때문에 ...
코드를 읽으며 '우와- 이 개발자 불친...' 라는 생각과 함께 주석을 건너뛰게 되는 내 모습을 발견하게 되었다! 그래서 '책에서 말한 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다.' 라는 구절이 구구절절 공감가기도 하였다
나 역시 내 코드가 부족하다고 느꼈을 때 보충 설명해주고 싶어서 주석을 작성한 경험이 있다.
머지 않아.. 주석을 달아놨음에도 불구하고 컴플레인이 들어왔었다. 처음에는 당시 내가 짠 코드에 이상한 자부심이 있었기 때문에 '왜 이걸 이해 못하지?' 라는 생각이 들었는데 지금 생각해보니 이름 짓는 능력이 부족한 것도 한 몫했던 것 같다. 상대방은 어려운 전공서적을 읽는 느낌이었을 것이다. 아니다 전공서적은 전문적으로 잘 알려주기라도 하지 아무튼 알 수 없는 한국어에 알 수 없는 코드,, 얼마나 힘겨웠을까 ㅋㅋ
난 이제 클린코드를 알게 되었으니 주석으로 설명할 필요가 없을 정도로 앞에서 배운 변수명, 함수명 짓기를 마스터✨해서 코드를 잘 짜는 날이 올 거라 믿는다.
그리고 생각나는 사례를 하나 말하자면, 현업에서 다뤘던 프로젝트 중 하나는 Java 1.8 버전을 썼을 정도로 예전 버전이었는데 파일마다 저자 표시가 되어있었다.
현재는 인텔리제이에서 알아서 표시해주기 때문에 왜 이걸..? 라는 생각과 함께 필요성을 못 느끼는데다 그 주석 때문에 코드가 복잡하고 어수선하게 느껴졌었다. 하지만 그 시절에는 자동 표시를 지원해주지 않아 달아놨던 주석임을 이해할 수 있었다.
내가 개발할 때는 저자 표시를 따로 하지는 않았지만 앞으로 그런 주석들을 발견하게 되면 과감하게 제거하여 정리하는 것도 좋은 방법일 수도 있겠다는 생각이 들었다. 시대가 변하면서 그 때 그 시절에는 맞다고 한 방법이 지금은 또 틀린 방법일 수도 있는 것처럼 주석의 히스토리를 알게 된 것 같아서 재밌기도 하였다.
가장 중요한 것은 주석을 달 필요가 없을 정도로 코드를 잘 짜는 것이겠지만 주석을 달아야 하는 이유를 잘 설명할 수 있다면 어느 정도의 적정선에서 주석을 달아두는 것도 나쁘지 않다고 생각한다.
🤔 궁금한 내용이나 잘 이해되지 않는 내용
주석이 없는데 코드도 못 알아보겠으면 어떻게 하나요 . . ? 😱
🏆 최애 TIL 선정
https://blog.naver.com/dbwlsajtwodd/223375524829
'내가 진절머리가 나면 나의 주석을 볼 사람들은 더 진절머리가 날 것이다.' 맞는 말입니다.. 소감을 되게 찰지게 잘 쓰셔서 재밌게 읽었습니다~
https://nomadcoders.co/community/thread/9532
반성글을 따로 적으셨더라구요. 저도 덩달아 반성하게 되었습니다^0^
https://gitlab.com/bonni-e/today-i-learned/-/blob/main/cleancode/Assignment05.md
git md파일로 정리하신 분은 이번에 처음 보는 것 같아요. 깔끔하게 잘 정리하셨습니다.
