Clean Code TIL, 4장. 주석

https://nomadcoders.co/community/thread/9977

Clean Code TIL, 4장. 주석 – 노마드 코더 Nomad Coders

 

 

오늘 TIL 3줄 요약

<예시>

• 사실상 주석은 기껏해야 필요악이다
• 주석으로 달려는 설명을 함수로 만들어 표현하자
• 주석을 달아야한다면 근처에 있는 코드만 기술하고, 전반적인 정보를 기술하지 마라.

</예시>

TIL (Today I Learned) 날짜

2024.06.27

오늘 읽은 범위

4장. 주석

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

• 프로그래밍 언어 자체가 표현력이 풍부하다면, 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라.
• 주석은 나쁜코드를 보완하지 못한다.
• 좋은주석 : 법적정보, 기본적인 정보제공, 의도,의미를 밝히는 주석, 결과를 경고하는 주석, todo주석, 중요성을 강조하는 주석
• 나쁜주석 : 주절거리는 주석, 중복된 내용, 오해할 여지가 있는 주석, 의무적으로 다는 주석, 있으나마나한 주석 => 이러한 주석들은 개발자가 주석을 무시하는 습관에 빠지게한다.
• 주석이 필요하지 않도록 코드를 개선하는 편이 낫다.
• 닫는 괄호에 주석을 달아야겠다는 생각이 든다면, 주석을 다는 대신 함수를 줄이려 시도하자.
• 공로, 저자를 표시하는 주석, 코드를 주석으로 처리하는 것은 소스 코드 관리 시스템에 저장하는 것이 더 좋다,

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

• 가장 공감갔던 내용은 책에서 말하는 나쁜 주석들은 개발자가 주석을 무시하는 습관에 빠지게한다. 는 말이었다. 그리고 공감이 아닌 새롭게 깨달은 점은 주석을 달지 않을만큼 표현을 잘하여 코드를 짜는 것이 좋다는 말이었다.
• 두번째로는 저자, 코드를 주석처리하는 것은 소스코드 관리 시스템으로 하는 것이다. 라는 말이었다.
• 주석을 달지 않아도 될 것 같은데 의무적으로 전에 다른 개발자분들이 개발한 것과 통일성을 갖기 위해서 달았던 적도 있고, 주절주절 내가 코드를 짜면서 이해하려고 주석을 남겼던 경험도 있는데, 그런것들이 쌓여서 레거시를 만든다는 생각을 하니 더욱더 신경써서 주석을 달아야 겠다라는 생각을 했다. 그리고 주석을 달지 않아도 될 만큼 함수를 잘짜야겠다. 함수의 순서도 위에서 아래로 잘 흐르게 배치하여야겠다.

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

• 책에서 리팩토링 한 코드를 보았는데 백프로 좋은 주석을 단 코드인 이유를 잘 모르겠다. 짧아지고 핵심만 전달하라는 것은 알았지만, 실제 내가 좋은 주석을 어떻게 다는게 좋을지에 대한 예로는 이해가 아직 부족한 것 같다.