728x90
4장. 주석
- 나쁜 코드에 주석을 달지마라. 새로 짜라
- 우리는 코드로 의도를 설명하지 못해, 즉 실패를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다.
- 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 주석을 유지하고 부수하기란 현실적으로 불가능하기 때문이다.
- 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
- 각 소스 파일 첫 머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
- 앞으로 할 일을 TODO주석으로 남겨주면 편하다.
- 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 쓰곤 한다.
- ☆☆함수나 변수오 표현할 수 있다면 주석을 달지마라.
- 주석을 달아야 한다몀 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
[출처] 클린코드 - 로버트C.마틴 지음
- 나쁜 코드에 주석을 달지마라. 새로 짜라
- 우리는 코드로 의도를 설명하지 못해, 즉 실패를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다.
- 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 주석을 유지하고 부수하기란 현실적으로 불가능하기 때문이다.
- 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
- 각 소스 파일 첫 머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
- 앞으로 할 일을 TODO주석으로 남겨주면 편하다.
- 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 쓰곤 한다.
- ☆☆함수나 변수오 표현할 수 있다면 주석을 달지마라.
- 주석을 달아야 한다몀 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
[출처] 클린코드 - 로버트C.마틴 지음
728x90
반응형
'개발, 코딩 > 일반상식' 카테고리의 다른 글
[clean code] 좋은 코드를 짜는길...(6) (0) | 2018.11.15 |
---|---|
[clean code]좋은 코드를 짜는길...(5) (0) | 2018.11.13 |
[clean code]좋은 코드를 짜는길...(3) (0) | 2018.11.09 |
[clean code] 좋은 코드를 짜는길...(2) (0) | 2018.11.07 |
[clean code] 좋은 코드를 짜는길...(1) (0) | 2018.11.07 |