Head On

Whilst on the topic of aggravation:

/**
 * Returns the url for the link
 * @return the url for the link
 * @param oFooUtil the foo util
 * @param sSomething the something
 * @param iAge the age
 */
public String getRelationPath(FooUtil oFooUtil, String sSomething, int iAge) {
    ...
}

1. Do not name your methods deceptively and keep the correct information in the javadoc only
2. Do not use hungarian notation. It is extra useless in Java as it is an object oriented language which means that many, many variables will be prefixed with o.
3. Do not comment the obvious

This entry was posted on Monday, December 5th, 2005 at 17:54 and is filed under General, Programming. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.