I totally agree with "the code should speak for itself". I follow the same principals. But when looking at something it's at class level, or when seeing a method sometimes it's not clear exactly what it's purpose is. So basic class/method descriptions are very useful. And an API doc as well. Especially if the code grows very large it becomes almost impossible for everyone to know about everything and JavaDoc can save a lot of time/detours.
Quintin Beukes On Mon, Oct 19, 2009 at 1:25 PM, Jacek Laskowski <[email protected]> wrote: > On Fri, Oct 16, 2009 at 3:40 PM, Quintin Beukes <[email protected]> wrote: > >> The OpenEJB javadoc is quite sparse. I've especially noticed it when >> reading through the code to learn how something works. >> >> Is this intended, or has there just not been time for it? > > The code should speak for itself, but if it doesn't go and add the > javadoc where needed. > > Jacek > > -- > Jacek Laskowski > Notatnik Projektanta Java EE - http://www.JacekLaskowski.pl >
