TIL (Today I Learned)

2022.02.26

오늘 읽은 범위

4장. 주석

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

• 잘 달린 주석은 그 어떤 정보보다 중요하다. 경솔하고 근거없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과

• 잘못된 정보를 퍼뜨려 해악을 미친다. (P.68)

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다 (p.68)

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

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

• 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.(p.70)

• 법적인 주석 -때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다. (P.70)

• 정보를 제공하는 주석 - 때로는 기본적인 정보를 주석으로 제공하면 편리하다. (P.71)

• 의도를 설명하는 주석 - 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다. (P.72)

• 의미를 명료하게 밝히는 주석- 때때로 모호한 인수나 반환 값은 그 의미를 읽기 좋게 표현하면 이해하기쉬워진다. (P.72)

• 결과를 경고하는 주석- 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. (P.73)

• Todo 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 엄무를 기술한다. (P.74)

• 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. (P.76)

• 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다. (P.83)

• 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라. (P.88)

• 주석과 주석이 설명하는 코드는 둘 사이관계가 명백해야한다. 이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 하지 않겠는가? (P.89)

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

• 코딩시 주석을 다는 건 귀찮아서 거의 달지 않는 편이다.

  그러나 그렇게 지속되면 나중에 내가 무슨 작업을 한지 모르는 일이 다반사이다.

• 내가 작성하는 코드의 원활한 관리를 위해서는 간단하고 정확하게 표현하는 주석을 다는 연습이 많이 필요 할 듯 하다.

  이 책은 나의 귀찮아 하는 습관들을 고치라고 멱살 잡는 느낌이다.

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