[TIL] "클린코드" 5일차

DAY 5

오늘 읽은 범위 : 4장, 주석

 

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

• 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다. (p.68)
• 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라.(p.68)
• 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. (p.69)
• 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라! (p.69)
• 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다. (p.70)
• 주석이 올바른지 검증하기 쉽지 않다. 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다. (p.73)
• 프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면한다. (p.74)
• '앞으로 할 일' 을 //TODO 주석으로 남겨두면 편하다. -중략- 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라고 권한다. (p.74)
• 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.(p.76)
• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. -중략- 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다. (p.86)
• 주석 자체가 다시 설명을 요구하니 안타깝기 그지없다. (P.89)

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

• 주석을 다는 시간에 차라리 코드를 깨끗하게 하는 편이 났다. 이래저래 주석을 달아서 코드의 내용을 설명하는 것보다 코드 자체가 명료하게 자기에 대한 정보를 표현하는 것이 가독성이 좋다.
• 기왕 주석을 달 생각이라면, 최대한 명료하고 의도가 정확한 주석을 다는 것이 좋다.

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

• 정적 초기화 함수란 무엇일까?

메서드나 멤버변수에 static이라는 예약어를 정의하면 해당 멤버변수나 메서드들의 객체가 생성될 때 static 영역이라는 곳에 유일하게 생성되어지면서 모든 객체들이 공유하여 사용하게 된다.

static으로 선언되었다면 객체를 생상하지 않고 사용할 수 잇으며 아무리 많은 객체를 생성한다고 해도 static 변수는 오직 하나만 만들어지며 그것은 모든 객체가 공유한다.

static method 또한 static 변수와 마찬가지로 공유 개념으로 사용되며 한가지 주의해야할 점은 static 메서드 안에서 static이 아닌 변수들을 참조해서 사용할 수 없다.

 

오늘 읽은 다른 사람의 TIL

 

Eichi님의 블로그 : 내가 쓴 글은 책의 내용을 그대로 옴긴 느낌인데 , Eichi님은 한 번 고민해보고 요약하신 느낌이 들어서 한 눈에 보기에도 가독성이 좋았다.

https://handh0413.github.io/posts/%ED%81%B4%EB%A6%B0%EC%BD%94%EB%93%9C03%EC%9E%A5/

Clean Code 03장. 함수

seunghyun2님의 블로그 : 예제 코드가 깔끔하게 정리되어 있고 글을 작성하시는데 많은 노력을 기울이시는 것 같아서 보기 좋았다.

https://cojjangsh.tistory.com/181

클린코드 챌린지 DAY4 (2024.06.27)

lactofreee님의 TIL : 이렇게 한 눈에 잘 들어오는 글이 있다니, 나는 뭔가 주절주절 늘어놓는 편이라 이런 정리된 글을 보면 부러우면서 기분이 좋아진다. 꾸준히 봤으면 좋은 글.

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

[클린 코드] TIL 4장. 주석 – 노마드 코더 Nomad Coders