개발자 99% 커뮤니티에서 수다 떨어요!
TIL (Today I Learned)
2022.02.25
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
우리는 코드로 의도를 표하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다.
주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 이유는 단순하다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.
좋은주석
1. 법적인 주석
ex) 저작권, 소유권 정보 등
2. 정보를 제공하는 주석
기본적인 정보를 줏거으로 제공하면 편리하지만 함수 이름에 정보를 담는 편이 더좋다.
3. 의도를 설명하는 주석
4. 의미를 명료하게 밝히는 주석
인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
5. 결과를 경고하는 주석
6. TODO 주석
7. 중요성을 강조하는 주석
8. 공개 API에서 Javadocs
나쁜주석
1. 주절거리는 주석
저자에게 의미가 있을 수 있지만 그 의미가 다른 사람들에게는 전해지지 않는다.
2. 같은 이야기를 중복하는 주석
3. 오해할 여지가 있는 주석
4. 의무적으로 다는 주석
5. 이력을 기록하는 주석
6. 함수나 변수로 표현할 수 있다면 주석을 달지 마라
7. 위치를 표시하는 주석
8. 닫는 괄호에 다는 주석
9. 공로를 돌리거나 저자를 표시하는 주석
10. 주석으로 처리한 코드
11. HTML 주석
12. 전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라. 시스템에 관한 주석을 함수에 달지 말아라
13. 비공개코드에서 Javadocs
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
학부에서 공부할 때만 해도 주석을 자세하게 써놓는 것이 더 완성도 놓게 코드를 짜는거라고 생각했는데 함수와 변수의 이름만으로도 의미가 명확하게 짜는 코드가 더 이상적인 코드라는 것을 시간이 갈 수록 느낀다.
확실히 버전관리시스템을 사용함으로 많은 정보성 주석들도 필요없게되면서 공식적인 것들 아니면 주석을 쓰지 않는 방향으로 코드를 짜야겠다는 생각이 들었다.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
X