📅 TIL (Today I Learned): 2024.02.01
📋 오늘 읽은 범위: 4. 주석
😎 책에서 기억하고 싶은 내용을 써보세요.
주석은 기껏해야 필요악이다.
프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라.
- 우리는 '실패'를 만회하기 위해 주석을 사용한다.
- 주석은 언제나 실패를 의미한다.
이유는? 주석은 오래될수록 코드에서 멀어진다.
코드로 의도를 표현하라!
확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. (!= 코드는 훌륭한 수단이 아니라는 의미)
몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
좋은 주석?
있음~
- 법적인 주석: 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보 (필요하고 타당해서)
- 결과를 경고하는 주석
- TODO 주석 (너무 남발하면 별로)
나쁜 주석
되게 많은데 내가 기억하고 싶은 것만,
- 주절거리는 주석 (의미가 명확하지도 않고 뜻을 알아내려면 다른 코드를 뒤져야 하는...)
- 같은 이야기를 반복하는 주석
- 이력을 기록하는 주석 (이젠 안 해도 되니까)
- 닫는 괄호에 다는 주석 (어쩐지 불편하더라..)
- 주석으로 처리한 코드
- HTML 주석
🥺 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.
이번 내용은 이전 편인 '함수' 편에 비해 읽기가 훨씬 쉬웠다.
평소에도 습관처럼 지키고 있던 부분이라 내용이 더 쉽게 와닿았기 때문도 있고,
함수에 비해서는 주석을 덜 중요시 여기기 때문일 수도 있다.
전자라면 잘하고 있는 것이고 후자라면 한 번 더 읽어야 하는 것이겠지...
음!
확실히 내가 신입 개발자일 때와 비교하면 나의 주석을 쓰는 비율이 현저히 적어졌다.
옛날에는 주석을 다는 것이 당연하다고 생각했고, 기록을 남겨야 한다고 생각했다.
클린한 코드를 지향해온 지금은... 조금은 달라졌다.
스파게티 코드나 다른 사람들이 이해하지 못 할 부분에서만 고심해서 깔끔하게 달아두고, 주석은 거의 달지 않는다. 주석 처리된 코드도 깔끔하게 지워버린다. (어차피 남으니까)
내가 잘하고 있다는 증거로 느껴지기도 해서 뿌듯하다.
🤔 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
이번엔 없다!
과제 2. 나의 최애 북틸
여태까지 남의 TIL을 읽어보지 않았는데...
이번 기회로 다 읽게 됐다. ㅠ 정말 슬랙에 올라온 건 다 읽었다...
내용은 나도 책을 읽었으니 주로 소감 위주로 보았고,
다른 분들의 TIL에 대해 언급하기 때문에 밑의 후기는 경어체로 작성할 것이다.
1. daehun님
https://daehun.notion.site/TIL-2-of-22-1-cda13e440d9049a2b6f56a3af785eac5
https://daehun.notion.site/TIL-4-of-22-3-e5d179d1ced94108a6d78d11762b397e
TIL을 진정성 있게 작성하신 게 느껴지는 글이었습니다.
좋다고 느낀 글들의 url을 추렸는데 같은 분이 작성하신 게 2개가 나오네요 ㅎ
읽은 부분에서 그치지 않고 함께 공부하면 좋을 내용을 공유한 것이 좋았고,
함수 부분에서는 제가 느꼈던 바를 동일하게 느껴서 공감도 되었고 return 부분에서는 스스로 생각하는 바를 내비치는 마인드가 좋았습니다.
2. jamie님
https://jamie-log.notion.site/Clean-Code-3-bfe7d923a5414225bdf8e6974cb25efd
노션에 쓰는 사람들이 대체로 열심히 쓰고 잘 쓰시는 분들인가?...
소감에 배운 내용 외에 알고 있는 지식이 녹여져있는 것 같아서 다시 한 번 더 읽게 되었습니다.
그러니까, 읽은 내용에 내 경험을 합친 게 좋았습니다.
3. ujaa님
글의 템플릿이 첫인상을 깊게 남겼습니다. 참고할 url을 남겨주신 게 좋아서 고르게 되었습니다.
