On Thu, Mar 31, 2011 at 8:56 AM, phil swenson <[email protected]> wrote: > There are some good practices here. > However I disagree with: "religiously adding doc comments that explain what > classes and methods are supposed to do. It often makes sense to document > fields with their invariants with respect to each other too." > I would argue you should name your classes, methods, and variables properly > so you don't have to religiously document them. However, often you need > supplemental comments/doc to make things clear.
I have yet to see a way to codify the correct amount of documentation that should go into something. It is more like the definition of art where "you know it when you see it." :( I have become more of a fan of internal DSLs/Fluent APIs/whatever because of this issue. -- You received this message because you are subscribed to the Google Groups "The 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.
