2024 3 7

요약

나쁜코드에 주석을 달지마라 주석은 필요악이다.

코드는 시대에 따라 변해가지만 주석은 그대로 인 경우가 많아 엄청난 혼란을 일으킨다

주석이 필요없는 방향으로 코드를 짜는게 최선이다.

그럼에도 불구하고 그나마 좋은 주석이라극 것은 아래와같다

1. 법적인 주석 : 저작권 정보와 소유권 정보는 필요함.

2. 정보를 제공하는 주석

3. 의도를 설명하는 주석

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

5. 결과를 경고하는 주석

6. TODO 주석

7. 중요성을 강조하는 주석

나쁜 주석 예

1. 주절 거리는주석

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

3. 오해할 여지가 있는 주석

4. 의무적으로 다는 주석

5. 이력을 기록하는 주석

6. 있으나 마나한 주석

7. 무서운잡음 :함수나 변수로 표현할수 있다면 주석을 달지마라

8. 위치를 표시하는 주석

9. 닫는 괄호에 다는 주석

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

11. 주석으로 처리한 코드

12. html 주석

13. 전역 정보 : 코드 일부에 주석을 달것, 시스템 전반적인 정보기술 하지 말라

14. 너무 많은 정보

15. 모호한 관계

16. 함수헤더: 짧은 함수는 주석 필요없음

17. 비공개 코드에서 javadocs

다른 사람 til 추천

https://nomadcoders.co/community/thread/9528 내용이 간결함.

https://nomadcoders.co/community/thread/9526 요약을 잘함

https://nomadcoders.co/community/thread/9523 내용이 간결함.