먼저 정리하기?

15장. 중복 댓글 삭제

이 작품은 AI를 사용하여 번역되었습니다. 여러분의 피드백과 의견을 환영합니다: [e-mail]

코드가 정확히 무엇을 말하는지 설명하는 댓글이 보이면 해당 댓글을 삭제하세요.

코드의 목적은 컴퓨터가 수행하기를 원하는 작업을 다른 프로그래머에게 설명하는 것입니다. 주석과 코드는 작성자와 미래의 독자에게 서로 다른 장단점을 제시합니다. 산문에서는 원하는 것은 무엇이든 설명할 수 있습니다. 반면에 시스템이 변화함에 따라 산문의 정확성을 다시 확인할 수 있는 메커니즘이 없으며 코드가 발전함에 따라 주석이 중복될 수 있습니다.

어떤 사람들은 소통의 의무를 편협한 시각으로 바라보며 모든 루틴에 댓글을 달아야 한다는 식의 독단적인 규칙을 고집하기도 합니다. 이로 인해 다음과 같은 댓글이 달립니다:

getX()
  # return X
  return X

이 댓글은 혜택 없이 비용만 발생시킵니다. 작성자로서는 독자의 시간을 낭비한 것뿐이며, 독자는 이 시간을 복구할 수 없습니다. 댓글이 완전히 중복되는 경우 삭제하세요.

Tidy는 종종 을 서로 연결합니다. 이전 Tidy 작업으로 인해 댓글이 중복되었을 수 있습니다. 예를 들어 원래 코드는 다음과 같을 수 있습니다:

if (generator)
    ...a bunch of lines of code to set up the generator...
else
    # no generator, return the default
    return getDefaultGenerator()

가드 절로 정리한 후 코드는 다음과 같이 보입니다:

if (! generator)
    # no generator, return the default
    return getDefaultGenerator()

...a bunch of lines of code to set up the generator...

이 주석은 처음에는 중복되지 않습니다. 다른 컨텍스트(생성기 있음, 설정 필요)에서 여러 줄의 코드를 읽은 후 현재 컨텍스트(생성기 없음)에 대한 우리의 주의를 으로 돌려줍니다. 그러나 Tidy를 마치고 나면 주석은 코드가 말하는 내용을 간단히 다시 설명하는 것에 불과합니다. 그러니 삭제해 봅시다. 그럼 안녕히 가세요.

파트 2에서 체인 연결에 대해 자세히 설명하겠습니다.