반응형
TIL (Today I LeTIL (Today I Learned)
2022.02.24
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
- 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리가 프로그래밍 언어를 치필하게 사용해 의도를 표현할 능력을 가지고 있다면, 주석은 전혀 필요하지 않다. (p.68)
- 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.(p.69)
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
- 본인이 이해하기에, 좋은 주석은 법적인 주석, 의도를 설명하는 주석, 결과를 경고하는 주석, TODO 주석, 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하는 주석이 있다. 그외의 주석은 코드를 통해서 해결할 수 있고, 나쁜 주석이다.
- 만약 주석을 달아야 한다면, 반드시 코드를 처음 보는 사람이 이해할 수 있도록 주석을 작성해야 한다. 혼자 이해하고 글쓴이만 이해할 수 있는 주석은 필요없다.
- 본인은 PS(알고리즘)을 풀면서 주석을 많이 단다. 금방 어떤 논리로 코드를 작성했는지 까먹어서 ㅎㅎ... 강의를 듣고 코드를 따라치면서도 주석을 많이 작성한다. 그러나 프로젝트나 어떤 프로그램을 만들면 최대한 주석은 작성하지 않으려고 한다. 이 습관을 그대로 유지해야겠다.
- 이전 장에서도 나왔지만 의도를 잘 전달하는 코드가 중요하다. 의도를 잘 드러내는 코드를 작성하면 주석을 작성할 필요도 없다. 본인은 그런 코드가 변수와 함수의 의도를 정확히 드러내는 이름 작명과 함수 작성이라고 생각하며 이를 다시 상기하면서 이전 장을 읽어봐야겠다.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
반응형