주석

좋은주석과 나쁜주석

좋은 주석

• 코드에 addon 되는 주석
• 코드로 대체될 수 없는 정말 필요한 정보로 해석에 도움이 됨

나쁜 주석

• 코드로 대체될 수 있는 주석
• 형상관리로 대체될 수 있는 주석
• 관리가 되지 않아 혼란을 가중하는 주석
• 변수나 함수명으로 충분이 대체될 수 있었던 주석
• 죽은 코드주석

드라이하게 표현하자면 위와 같이 정리할 수 있을 거 같다.

이상적으로는 위와 같은 케이스가 분명하게 구분될 수 있을거 같지만 현실적으로는 애매한 경우도 많다.
보통 코드로 대체될 수 있는 주석 인데, 이 과정은 사실 한 팀이 같은 방향의 사고를 바탕으로 컨벤션을 충실히 따른다면 좀 수월할 수 있지만 여러가지 이유로 쉽지않다.

그래도 이상적인 방향을 정리하면서 생각을 정리하는데 많은 도움이 되고 있다. 화이팅!!