Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
CleanCodeTIL[4] = "주석"
#clean_code
2년 전
576

오늘 TIL 3줄 요약

  • 주석은 가독성을 망가뜨리니 쓰지말자

  • 좋은 주석과 나쁜 주석은 따로 있다.

  • 주석을 쓰지 않고 코드로 설명할 수 있도록 코드를 정리하라.

TIL (Today I Learned) 날짜

2022. 04. 29

오늘 읽은 범위

4장. 주석

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

  • 실패를 만회하기 위해 주석을 사용한다.(p68)

  • 코드만이 정확한 정보를 제공하는 유일한 출처다.(p69)

  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라 (p84)

  • 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다.(p86)

  • 소스코드 관리 시스템이 우리를 대신해 코드를 기억해준다.(p87)

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

  • 주석을 쓰지 않고 코드를 짰을 때 이해하기가 어려워 주석을 많이 단 적이 있었다. 결국 그 코드도 오히려 더 복잡하고 정신없었다. 이제야 이 책을 읽으며 이해할 수 있었고, 주석을 쓰는 것 보다 코드를 정리하는 것이 더 좋다는 사실을 배웠다.

  • 이전에는 썼던 주석이지만 요즘은 소스코드 관리 시스템들이 해준다는 게 인상 깊었다.

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

없음

오늘 읽은 다른사람의 TIL

없음