TIL (Today I Learned)

2022.02.24

오늘 읽은 범위

4장. 주석

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

• 나쁜 코드에 주석을 달지 마라. 새로 짜라. - 브라이언 W. 커니핸, P.J. 플라우거 (p.68)

• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. (p.69)

• 진실은 한곳에만 존재한다. 바로 코드다. (p.69)

• 주석이 코드보다 더 많은 정보를 제공하지 못한다. (p.77)

• 우리는 오래 전부터 우수한 소스 코드 관리 시스템을 사용해왔다. 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다. (p.87)

• 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. (p.89)

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

• 코딩을 잘하지 못하고 코딩에 자신이 있지도 않아서 주석이 많이 필요한 코드를 작성할 일이 없었다. 주석을 사용하는 경우는 알고리즘을 풀고 설명을 덧붙일 때 정도이다. 또는 다른 사람의 코드를 분석하며 기억하거나 스스로의 이해를 돕기 위해서 사용했었다. 그러나 내 주석들을 생각해 보면 코드로 충분히 설명되는 것들을 주석으로 표현하는 등 저자가 싫어할(?)만 한 코딩을 했던 것 같다. 앞으로는 주석을 의미 있게 사용하는 그런 사람이 되겠어..!라고 다짐해 본다.

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

• Javadocs? - Java 소스 코드에서 HTML 형식의 API 문서를 생성하기 위해 Sun Microsystems에서 Java 언어용으로 만든 문서 생성기이다. /** 내용*/ 의 형식으로 사용한다.