이전 페이지

3장. 함수

요약: 주석보다는 코드로 설명하라

하지만 명심하기 바란다. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!

주석이 필요한 경우

<aside> 💡 주석이 없는 코드가 가장 좋지만 아래와 같은 경우에는 사용할 수 있다.

</aside>

• Copyright (C), Apache License와 같은 법적인 내용들
• 입출력에 대한 기본적인 정보 but 함수 이름에 정보를 담을 수 있으면 함수로 만드는 것이 낫다.
• 구현한 알고리즘 등 의도를 설명하는 주석 ex) 에라토스텔네스의 체, 하노이의 탑 등
• 실행 결과에 대한 경고 ex) 많은 메모리 또는 시간을 소요, thread safe 하지 않음
• TODO
• 주의 환기용 배너 코드

// Actions /////////////////////////////////