TIL (Today I Learned)

// 2022.02.24

오늘 읽은 범위

// 4장. 주석

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

• 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라. (p.68)

• 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. (p.68)

• 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다. (p.69)

• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. (...) 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다. (p.69)

• 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라. (p.69)

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

• 팩폭의 연속인 챕터였다. 좋은 주석의 종류를 읽을 때에는 '오 이럴때에 주석을 달면 되겠다'고 생각했는데 나쁜 주석의 종류를 읽을 때는 하나같이 내가 의도한 주석이라서 웃으면서 읽었다. 프로젝트를 하면서 함수마다 Javadocs을 많이 작성했는데 귀찮긴 했지만 그래도 도움이 될 것이라는 생각에 작성했었다. 여기서 말하듯 복붙으로 엉망이 된 소스가 대다수였다.😅

• 그리고 유지보수로 인한 수정 또는 추후에 다른 개발자가 작업하게 될 것 같은 소스에는 언제 누가 작성했는지를 표시하는 주석도 자주 달았었다. 혹시나 문제가 된다면 나를 찾아오라는 뜻이었는데 나중에 시간이 지나면 기능은 물론 내가 주석을 왜 달았지하는 생각을 했었다. 버전관리를 했음에도 왜 그랬나 모르겠다..

• 그럼에도 주석을 완전히 없애기는 힘들지 않을까 싶다. 주석을 달아둠으로써 코드를 정확히 안보고 넘어갈수도 있다. 코드에 모든 것을 담아야 하지만 아무래도 비영어권에서 영어로 짠 코드에는 어느정도의 주석은 필요하지 않을까하는 생각이다.

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