Linked by Jesse Smith on Wed 14th Apr 2010 21:00 UTC
Thread beginning with comment 419381
To view parent comment, click here.
To read all comments associated with this story, please click here.
To view parent comment, click here.
To read all comments associated with this story, please click here.
RE[5]: I will risk it
by lucas_maximus on Sat 17th Apr 2010 13:14
in reply to "RE[4]: I will risk it"
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:
2007-04-29
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.