Clean Code #4 : 주석을 써? 말어?

  좋은 주석은 뭐고 나쁜 주석의 차이는 뭔지 곰곰히 생각해보자..
내 생각은 좋은 주석은 없다. 주석이 없는 주석이 가장 좋은 주석이다. 물론 코드가 개발자 의도를 100% 표현 했다는 가정 하에!☝️

  나의 경우는 내가 짠 코드의 일부분을 혹시나 다른 개발자가 못알아 듣거나 이해를 못할까 걱정이 되어 주석을 사용하곤 한다. 즉 내가 나를 못믿는데 누군가 나를 어떻게 믿을까😥😥😥
대부분의 주석은 쓸때 없는 주석, 주절거리는 주석 등으로 이루어 지지만 난 가장 필요한 주석은 히스토리 주석과 TODO주석이라 생각한다.

 

 

 

 

☝️소스코드 관리 시스템이 있다 한들, 특정 부분이 수정된 사유와 날짜 등을 파악하려면 시간을 들여야한다.

✌ TODO주석이 있다는 말은 일을 다 못끝냈다는 이야기. 그러나 그 누가 하루만에 개발을 다 해? 중간에 쉬어 갈 수도 있고, 다음 날 일을 다시 시작 할 때 어제 내가 어디까지 했는지, 뭐부터 하면 되는지 정리해놓으면 시너지가 어마어마 할 수도 있다.

 

개인마다 차이가 있겠지만, 때에 따라서도 다를 수도 있고 팀 룰에 따라서도 다를 수 있다. 답은 없는 것 같다. 활용해도 좋고, 활용하지않고 읽기 쉬운 코드를 작성해도 좋다. (자신 있다면..ㅎㅎㅎ)