개발자 99% 커뮤니티에서 수다 떨어요!
오늘 TIL 3줄 요약
개발자는 코드로 말하는 직업
주석을 나쁜 코드를 보완하지 못한다.
나쁜 주석 쓰기만 피해도 꽤 괜찮은 개발자 일지도..?
TIL (Today I Learned)
2024. 06.26
오늘 읽은 범위 - 3장. 함수
책에서 기억하고 싶은 내용을 써보세요.
주석의 역할과 한계
-주석은 코드의 의도를 명확하게 표현하지 못할 때 사용된다.
코드는 지속적으로 변화하고 진화하는 반면, 주석은 그 속도를 따라가지 못해 부정확한 정보를 제공할 수 있다. 부정확한 주석은 없는 것보다 나쁠 수 있으며, 주석을 최소화하고 코드를 명확하게 작성하는 것이 중요하다.
주석은 나쁜 코드를 보완하지 못한다
-주석이 있는 코드보다 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드를 작성하는 것이 좋다.
함수명만 명확하게 지어도 따로 의도를 명시하는 주석이 필요 없다.
좋은 주석의 예
법적인 주석: 코드의 저작권이나 라이선스 정보를 포함
정보를 제공하는 주석: 메서드가 반환할 값을 설명하거나 사용한 정규표현식의 의미를 설명
의도를 설명하는 주석: 특정 코드 블록의 목적이나 이유를 설명
결과를 경고하는 주석: 예상치 못한 결과를 미리 경고
ToDo 주석: 필요하지만 당장 구현하기 어려운 업무를 기술
나쁜 주석의 예
특별한 이유 없이 주절거리는 주석: 불필요한 이야기가 담긴 주석
같은 이야기를 반복하는 주석: 이미 명확한 내용을 반복하는 주석
오해할 여지가 있는 주석: 잘못 해석될 수 있는 주석
의무적으로 다는 주석: 함수나 변수로 표현할 수 있는 내용을 주석으로 다는 경우
주석으로 처리한 코드: 제거되지 않고 주석 처리된 코드
너무 많은 정보를 담은 주석: 코드 일부에 주석을 다는 것이 아니라 시스템 전반에 대해 장황하게 설명하는 주석
핵심 요약
주석은 코드의 의도를 명확하게 표현하지 못할 때 사용하는 도구로, 주석을 최소화하고 코드 자체를 명확하게 작성하는 것이 좋다. 좋은 주석은 필요한 정보를 제공하고, 나쁜 주석은 오히려 코드의 가독성을 해칠 수 있다. 주석 대신 함수명이나 변수명 등으로 의도를 표현하는 것이 중요.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
다시 한번 기본기의 중요성과 좋은 함수명과 변수명으로 의도를 명확히 표현하는것이 얼마나 중요한지 새기게 된다. 개발자는 코드로 이야기하는 직업이다. 최소한의 코드로 의도한 바를 정확하고 깔끔하게 전달할 수 있어야만한다.
나의 최애 북틸
wltjs8958님의 TIL (https://nomadcoders.co/community/thread/9966)
이유: 챌린지 초반 #clean_code 커뮤니티에 올라오던 TIL 수가 지금은 많이 줄었다. 그럼에도 피드를 함께 장식하고 있는 동료 학습자에게 경의와 응원을 보내며..
vitaminFE님의 TIL (https://vitamin-fe.tistory.com/39)
이유:우리보다 한 기수 앞서 클린코드 챌린지를 우수히 완수하신 선배 학습자의 끈기와 열의에 존경을 표하며..
DeveloperFEEL님의 TIL (https://nomadcoders.co/community/thread/9886)
이유:이하 동문
덧붙이는 말
혼자서 독학으로 프로그래밍 공부를 한다는 것은 매일이 나와의 싸움인 것 같습니다.
굉장히 진부하고 틀에 박힌 말이지만 사실이 그렇습니다.
저 또한 공부를 하면 할 수록 내가 얼마나 나태하고 게으른 인간인지 확인하면서 다시금 스스로를 채찍질 해봅니다.
노마드 코더 챌린지 지원페이지를 보면 "챌린지는 빡셉니다." 라는 문구가 보입니다.
정말 그러한가?, 막상 학습자에게 요구되는 과제의 양과 수준은 그리 빡세지 않습니다. 그럼에도 불구하고 참여율이 높지 않은 이유는 "매일 해야 한다" 라는 점 때문이 아닐까 싶습니다.
저 역시 가벼운 마음으로 몇 차례 챌린지를 신청 했다가 탈락해 왔습니다.
이번 만큼은 절치부심하여 끝까지 완주 할 수 있도록, 노력해 보고자 합니다. 부디 많은 동료 학습자들께서도 끈기를 잃지 말고 끝까지 함께 완주하길 응원합니다!
오늘의 슬랙
