If you're the author and only active user of the code, I think that's okay. But otherwise, I'm sorry to say it, that's just an excuse not to write documentation.
And wait for when you got away from it for six months. Let's see if you can still read it undocumented. :-) And as a user of an api, would you rather read the code or the javadoc ? I'm among those old-school idiots who believe documentation is part of the code. Luckily there's JavaDoc to generate readable reference documentation automatically. On Fri, Aug 17, 2012 at 11:18 AM, Carl Jokl <[email protected]> wrote: > I had a discussion very recently within my company regarding the source > code produced and that it has almost no comments in it. I was told quite > confidently by the developer I spoke to that this was a deliberate company > decision and that the code should be clear enough that no comments > were necessary. Also it was said that the code and methods were changing so > often that it would just be painful overhead to keep JavaDoc comments up to > date. > > I understand the principle of trying to make code self documenting and > clear enough so that it does not need lots of documentation. I am not sure > however how I feel about the idea of using this argument not to add much of > any comments at all. Am I just not with the times or Agile enough? > > What are your thoughts? > > -- > You received this message because you are subscribed to the Google Groups > "Java Posse" group. > To view this discussion on the web visit > https://groups.google.com/d/msg/javaposse/-/NfzND7O7M4YJ. > To post to this group, send email to [email protected]. > To unsubscribe from this group, send email to > [email protected]. > For more options, visit this group at > http://groups.google.com/group/javaposse?hl=en. > -- You received this message because you are subscribed to the Google Groups "Java Posse" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/javaposse?hl=en.
