Comment? Comment!

   회사에서 회고를 매주 하고 있는데 인수인계를 받았거나 다른 사람의 작업을 받아서 일하는데 어려움이 있단 말이 나왔습니다.  그래서 이를 해결할 방법으로 문서와 comment이야기가 나왔습니다. 문서야 그렇다지만 도데체 주석을 어떻게 써야되는지 사람들이 잘 모르더군요. 그래서 빼든 책이 바로 Code Complete죠. (한국어판) 제발 개발 일 하시겠다는 분들은 읽어주세요... 제발.

 주석을 어떻게 달아야 되냐, 한마디로 코드의 의도와 목적이 뭔지 적으라는 것입니다. 아래 코드가 무엇을 의미하는지 어떻게 된 것인지 적어야 나중에 본인 스스로도 헤메지 않을 것입니다. 

 마지막으로 Code complete에서 소개한 Book paradigm이란 방법론을 소개했습니다. 한마디로 요약하면 '코드를 일종의 특별한 책으로 생각하고 이에 맞춰서 주석을 달아라'라는 내용입니다. 이후 이런 연구는  From code understanding needs to reverse engineering tool capabilities 같은 연구들로 이어집니다.

  아직 한국이 지적사회가 되지 못하는 이유 중 하나는 이런 업계의 숱한 잘못된 것들을 개선하거나 혹은 개선점이 있음에도 무시하고 넘어가는 부분들을 학술계에서 해결해 주려는 시도가 많지 않은 탓이 크지 않을까 싶습니다. 사실 큰 연구만 영향력이 큰게 아니라 이런 연구들이 현장에서는 많이 와닿고 또 효과가 있기 때문입니다.

 혹시 전산과에서 다음학기 수업을 고민하는 교수님들이 있다면 제발  Code construction에 대한 수업을 진행해 주셨으면 합니다. 이게 실제 회사에서는 '먹힌'답니다.