Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL 4장. 주석
#clean_code
2년 전
542


TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장 주석

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

  • 나쁜 코드에 주석을 달지 마라. 새로 짜라. ~사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라. ~때때로 주석 없이는 자신을 표현할 방법을 찾지못해 할 수 없이 주석을 사용한다. (68p)

  • 주석은 나쁜 코드를 보완하지 못한다. ~표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. (69p)

  • 코드로 의도를 표현하라! ~많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다. ~정말로 좋은 주석은, 주석을 달지 않는 방법을 찾아낸 주석이라는 사실을! ~ (70p)

  • 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. (76p)

  • 코드보다 읽기가 쉽지도 않다. 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다. ~쓸모없고 중복된 Javadocs가 매우 많다. 아래 주석은 코드만 지저분하고 정신 없게 만든다. 기록이라는 목적에 전혀 기여하지 못한다. (77p)

  • 이력을 기록하는 주석. ~혼란만 가중할 뿐이다. 완전히 제거하는 편이 좋다. (81p)

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

  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라. (84p)

  • 짧은 함수는 긴 설명이 필요 없다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 휠씬 좋다. (89p)

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

  • 주석가지고 장난치거나, 잘난척하지 말아야 겠다.

  • 주석을 다는 바에는 코드를 잘 짜는게 낫다.

  • 수식어 자제하고 직관적으로 주석 달아야 겠다.

  • 저자의 내용을 모두 수용하지는 않지만, 팀워크에 효율성을 주는 주석의 첨부는 좋을 것 같다.

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

  • 소스 코드 관리 시스템 - IDE?, 코드 편집기?