개발자 99% 커뮤니티에서 수다 떨어요!
오늘 TIL 3줄 요약
모든 주석은 악이다.
주석을 잘쓰려고 노력할 바에는 코드를 잘 짜는것이 백배 낫다.
꼭 주석을 써야한다면,,, 최대한 안쓰려고 노력해라.
TIL (Today I Learned) 날짜
2022. 05. 09
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 주석은 '순수하게 선하지' 못하다. 사실상 주석은 기껏해야 필요악이다.(p. 68)
주석을 달바에 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다. 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!(p. 69)
코드로 의도를 표현하라!(p. 70)
어떤 주석은 필요하거나, 유익하다. 1. 법적인 주석, 2. 정보를 제공하는 주석, 3. 의도를 설명하는 주석, 4. 의미를 명료하게 밝히는 주석, 5. 결과를 경고하는 주석, 6. Todo 주석, 7. 중요성을 강조하는 주석, 8. API, 9(p. 75)
대다수의 주석이 나쁜 주석이다. 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다. 1. 주절거리는 주석, 2. 같은 이야기를 중복하는 주석, 3. 오해할 여지가 있는 주석, 4. 의무적으로 다는 주석, 5. 이력을 기록하는 주석, 6. 있으나 마나 한 주석, 7. 무서운 잡음, 8. 함수나 변수로 표현할 수 있다면 주석을 달지마라, 9. 위치를 표시하는 주석, 10. 닫는 괄호에 다는 주석, 11. 공로를 돌리거나 저자를 표시하는 주석, 12. 주석으로 처리한 코드, 13. HTML 주석, 14. 전역정보, 15. 너무많은 정보, 16. 모호한 관계, 17. 함수 헤더.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.
주석은 애초에 달지 말거나 잠시 달더라도, 모두 삭제하라고 배웠다.
예전에 적절한 주석조차, 소스관리 시스템과 IDE로 인해서 모두 쓸모 없어졌다.
지금 유익하다고 여겨지는 주석들 조차 나중에는 필요없는 것들이 되지 않을까?
습관적으로 나도 모르게 남기게 되는 주석들이 있다. 애초에 코드를 잘 짜도록 더 노력해야 한다.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
JavaDoc
오늘 읽은 다른사람의 TIL