Some Very Basic Code Standards
Posted on 05 Dec 2005 by Marcus Ahnve
Whilst on the topic of aggravation:
1 /**
2 * Returns the url for the link
3 * @return the url for the link
4 * @param oFooUtil the foo util
5 * @param sSomething the something
6 * @param iAge the age
7 */
8 public String getRelationPath(FooUtil oFooUtil, String sSomething, int iAge) {
9 ...
10 }
- Do not name your methods deceptively and keep the correct information in the javadoc only
- 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.
- Do not comment the obvious