Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

3 lines (2 sloc) 0.933 kb

문서화를 하지 않는 것을 정당화하는 흔한 주장 중 하나가, 코드 자체가 충분히 설명적이라면 문서가 필요하지 않다는 것, 그러니까 문서는 설명적이지 못한 후진 코드에서나 필요할 뿐이라는 얘기이다. 나는 당당하게 이런 말을 하는 사람을 만나면 좀 당황스럽다. 저렇게까지 얘기하는 것은 자신의 코드가 남달리 대단하다고 떳떳하게 말하는 게 아닌가?

하여간 저 말을 문서가 무엇을 위한 것인지 잘 이해하지 못하고 있다는 증거밖에 안된다. Javadoc으로 API 문서를 만들어내면 그게 문서일까? 문서화를 할 때 가장 공을 들여야 하는 부분은 레퍼런스 문서가 아니라 튜토리얼 같은 가이드 문서이다. 코드를 아무리 잘 써놔도 그걸 어떻게 빌드해야 하고 디플로이해야 하는지는 스스로 설명하지 못한다.

Jump to Line
Something went wrong with that request. Please try again.