주석

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

- 코드에 쓸데없는 주석을 붙이는 것은 자신의 코드에 자신이 없기 때문이다.

- 주석을 어떻게 쓸까 고민 할 시간에 더 깔끔한 코드를 작성하도록 노력하자

2. 우리는 프로그래머이다. 코드로 의도를 전달하자

3. 좋은 주석이란?

- 법적인 주석 : 저작권이나 소유권 정보

- 정보를 제공하는 주석

- 결과를 경고하는 주석

- TODO주석 : 앞으로 해야할 일을 적어놓는 주석. 그러나 나쁜 코드를 남기는 핑계가 되어서는 안된다. 또한 TODO주석은 너무 많아지면 안된다. 주기적으로 업데이트해서 깔끔하게 정리하자.

4. 나쁜 주석이란?

- 특별한 이유없이 의무감으로 다는 주석

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

- 이력을 기록하는 주석 : 이제는 깃허브라는 신이 있으므로 삭제하자

- 닫는 괄호에 다는 주석 : 작게 캡슐화된 함수를 지향하는 현대 코드에서는 맞지 않는다. 코드를 작게 만들어보도록 노력해보자

- 주석으로 처리한 코드덩어리 : 함께 작업하는 이들에게 코드의 수정 유무를 망설이게 강요한다.

 

참고)

https://zeddios.tistory.com/424

[Clean Code] 4 : 주석