클린코드 - 4장. 주석

클린코드 TIL(Today I Learned) - Day1 (2022.02.25)

오늘 읽은 범위

4장. 주석

책에서 기억하고 싶은 내용을 써보세요.

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. (p.68)
• 주석이 코드에서 분리되어 점점 더 부정확한 고아로 변하는 사례가 너무도 흔하다. (p.68)
• 나라면 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다. (p.69)
• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. (p.69)
• '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다. (p.74)
• TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. (p.74)
• 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다. (p.75)
• 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다. (p.83)
• 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자. (p.85)
• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니깐 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다. (p.86)
• 주석을 달아야 한다면 근처에 있는 코드만 기술하라. (p.88)
• 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라. (p.88)
• 짧은 함수는 긴 설명이 필요 없다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨신 좋다. (P.89)
•  

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.

• 책 예제 중에 주석에 프로그램 수정 내역, 알고리즘을 창시한 사람의 일생같은게 적혀있는 것들이 있었다. 나는 지금까지 그러한 주석을 한 번도 본적이 없었다. 이 책은 출판된지 매우 오래된 책이라 그런지 요즘에는 전혀 볼 수 없는 형식의 주석들이 간간히 보였다.
• 코드를 짜다가 이해가 되지 않는 부분이 있으면 인터넷에서 찾아서 그 코드와 함께 해당 설명을 주석으로 넣는 경우가 있었다. 앞으로 이러한 경우는 최대한 지양해야겠다.
• "코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다."라는 말에 절대적으로 동의한다. 내가 짠 코드라도 암묵적으로 이게 좋은 코드가 아니란걸 알기 때문에 주석 쓸데없이 길게 늘어 놓은 경험이 있다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• 쉰들러 리스트 - 미국에서 만든 전쟁 휴먼 드라마 영화. 제목 "쉰들러 리스트"는 주인공이 유대인들을 안전한 곳으로 피신시키기 위해서 작성했다는 9개의 명단이다.