Posts tagged with "documentation"

I’ll be traveling to Dallas, Texas this weekend to speak about agile documentation at Valtech Days.

I am looking forward to attending other sessions, the rest of the conference is looking really interesting. If you are in the area and want attend the conference, I believe there are still a few seats available.

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