90 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? >
IMO It is more important to have "big-picture" documentation, things like what the different components are, what they are supposed to do, and how they work together. Having javadoc on every class and method stating the obvious is just noise that doesn't get updated. 90% of the time even with documentation you are forced to go look at the source anyway. It is far more important to me that the source is available of any library that I use then if it has javadoc. Regards, -- 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.
