주석과 읽기 좋은 코드

개념 이해하기

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

20_000의 밑줄은 자릿수를 읽기 쉽게 끊어 주는 표기일 뿐 값은 20000과 같습니다. 주석 줄은 discount_rate가 왜 0.15인지, 즉 신규 회원의 첫 구매에만 적용된다는 조건을 알려 주는데 이 정보는 변수 이름만으로는 드러나지 않습니다. final_price는 20000에 0.85를 곱한 17000.0을 int로 바꿔 결제 금액: 17000을 출력하며, int는 반올림하지 않고 소수점 아래를 버립니다.

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

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