To view parent comment, click here.
To read all comments associated with this story, please click here.
I'll pick properly coupled code with good descriptive variable names over the average javadocced code anyday.
Javadoc describes your attributes, which is a good thing if you are coding an api. But to use it to make somebody understand your code it's useless. it does not describe the structure and logic behind your classes.
I've seen too many getFoo() functions with the the javadoc comment "gets foo". Try to pick you variable, class and method names so they don't need any javadoc.
I agree; our coding standard requires us to do what you have described, but I always try to use descriptive names...
... however I like to describe what the method does before even writing it, helps me think through the logic before I even start coding. Sometimes I write some pseudocode or draw a diagram, depends on what I am doing ultimately.




Member since:
2005-07-06
A programmer I've worked with used to say "everyone wants documentation, no one wants to pay for it."