2007. 8. 2. 18:52
주석(Comment)에 관하여. development2007. 8. 2. 18:52
남의 소스를 볼때마다 개인적으로 느끼는점중에..
하나는 정말 쓸데 없는 주석들을 많이 달아 놓는다는것.
아주 심플하게 예를든다면.
for(inti=0; i < cnt; i++) //i부터 cnt까지 반복
Logger.debug("aaa"); //확인 메세지를 뿌려줌.
하다못해 db커넥션하는것까지 주석을 덕지덕지 붙여놓는다.
도대체 이런 주석을 쓸필요가 어디에 있을까?
위에것은 내 개인적인 느낌이 팍 와닿도록 오버한감이 있지만..
정말 뻔한 주석을 덕지덕지 붙여놓은 소스를 볼때마다...
참.. 구지 보는사람짜증나게 저렇게 해놓을필요가 있을까 싶다.
짜는사람도 그런 필요없는 주석이 도움이 하나도 안될텐데..
주석은 제발 로직이 들어간부분.
소스를 봤을때 업무의 내용을 모르면 이해가 안간다거나..
일반적으로 봤을때 필요없는 로직이지만 필연적으로 해당소스가 들어가야했을시의 사유 등..
정말 필요할시에만 달았으면 하는 생각이 있다.
가끔 쓸데없는 주석때문에 소스의 이해가 더 어려울때가 있다.
