4장. 주석

1. 주석은 나쁜 코드를 보완하지 못한다.

2. 주석은 코드가 왜 존재하는지를 설명해야 하며, 코드 자체는 무엇을 하는지 설명해야 한다.

3. 주석은 간결하고 명확하며 읽기 쉬워야 한다. 길고 복잡한 주석은 피해야 한다.

4. 주석은 복잡한 알고리즘이나 해결책 등과 같이 예상치 못한 코드를 설명하는 데 사용해야 한다.

5. 주석은 코드 변경 사항을 기록하고 수정 내역을 제공하는 데 사용해야 한다.

6. 주석은 설명하는 코드와 함께 최신 상태로 유지되어야 한다.

7. 주석은 일관된 스타일과 형식으로 작성되어야 한다.

좋은 주석이란?

• 법적인 내용이 들어가는 주석

• 정보를 제공하는 주석

• 의도를 설명하는 주석

• 의미를 명료하게 밝히는 주석

• 결과를 경고하는 주석

• Todo 주석

나쁜 주석은?

• 주절거리는 주석

• 같은 이야기를 반복하는 주석

• 오해할 여지가 있는 주석

• 의무적으로 다는 주석

• 있으나 마나 한 주석

• 위치를 표시하는 주석

• 공로를 돌리거나 저자를 표시하는 주석

• ★주석으로 처리한 코드

• HTML 주석