주석과 읽기 좋은 코드

개념 이해하기

# 뒤의 내용은 실행되지 않는 주석입니다. 좋은 주석은 코드가 무엇을 하는지 반복하지 않고 왜 이런 선택을 했는지 설명합니다. 짧고 구체적인 이름과 적절한 빈 줄이 대부분의 설명을 대신하도록 작성하세요.

예제에서 # 이 줄은 주석입니다 부분부터 찾으세요. 값을 만드는 표현식과 그 값을 다음 문장으로 넘기는 흐름을 한 줄씩 따라가면 실행 결과를 스스로 설명할 수 있습니다.

주석은 한 줄 끝에도 쓸 수 있지만 너무 길면 코드를 읽기 어렵습니다. 여러 줄 문자열은 문자열 객체이므로 일반 주석과 완전히 같지 않습니다.

TODO에는 작업 내용뿐 아니라 이슈 번호나 제거 조건을 함께 남겨 영구적인 미완성 메모가 되지 않게 관리합니다.

이 코드는 브라우저의 실제 Python에서 실행됩니다. 먼저 현재 결과를 확인한 뒤 불필요한 주석 하나를 지우고 discount 이름만으로 계산 의도가 드러나게 바꿔보세요.