What really drives me nuts is, we're working in Java. We have Javadoc, which is an excellent tool. Class comments are the perfect place to explain what each class does, how it works, what it interacts with, etc. The problem is more the mentality than the tools, unfortunately. "We don't need to document this, we're the only ones who will ever see it". AAAAARGH!
A follow up comment: "Gav, have you documented this module?" To which the reply was "No. You wrote it and you've never explained it to anyone. I don't have a clue how it works." Fortunately, I didn't have to add "you should have documented it yourself", cos someone beat me to it.
![[personal profile]](https://www.dreamwidth.org/img/silk/identity/user.png)
branchandroot
but...
Date: 2003-01-24 03:04 (UTC)A follow up comment: "Gav, have you documented this module?" To which the reply was "No. You wrote it and you've never explained it to anyone. I don't have a clue how it works." Fortunately, I didn't have to add "you should have documented it yourself", cos someone beat me to it.