Community

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

← Go back
[TIL] Assignment-06 (22.02.25[금])
#clean_code
2년 전
415


TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장.주석

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

  • 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라, 아니. 전혀필요하지 않으리라.(p.68)

  • 좋은주석-법적인 주석, 정보를 제공ㄹ하는 주석, 의도를 설명하는주석,의미를 명료하게 밝히는주석,결과를 경고하는 주석,TODO주석, 중요성을 강조하는 주석

  • 나쁜주석- 주절거리는 주석, 같은이야기를 중복하는 주석,오해할 여지가 있는주석, 의무적으로 다는주석,이력을 기록하는 주석, 있으나 마나 한 주석함수나 변수로 표현할 수 있다면 주석을 달지 마라, 위치를 표시하는주석, 닫는 괄호에 다는 주석, 공로를 돌리거나 저자를 표시하는 주석, 주석으로 처리한 코드 HTML주석, 전역정보, 너무 많은 정보, 모호한 관계, 함수헤더!(정말많다..!)

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

  • 이번차트역시 "세상에"를 몇번이나 외쳤다.., 나쁜주석으로 나온 예시중 거의 대부분이 내가했던 짓들이였다. 특히 위치를 표시하는 주석! 코드가 길어지면 가끔 내가 어디에다가 코드를 적었는지 헷갈려서 //****************여기에 내코드가 있다!******************같은 느낌으로 표시해두곤했는데 책을 읽고 다시생각해보니 그러네,, 이렇게 절대하면 안되겠네 실무가서 이렇게 했다간 정말 큰일날뻔햇구나 싶었다.!

  • 좋은 코드는 코드자체로 의미를 말할수 있기 때문에 주석이 필요하지않다! 이게 핵심인듯

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

  • public synchronized void <