The only thing I'd add to Ben's points is: liberal use of informative comments is much encouraged and greatly appreciated :)
Michael On 24 September 2010 12:29, Ben Caradoc-Davies <[email protected]> wrote: > Tara, > > there is no convention on warnings. Generally we just fix things as we > go, although some maintainers (you know who you are) complain about > coding style fixes included with submitted patches as they can obscure > substantive changes. > > GeoTools before 2.6 was a Java 1.4 project. When generics were > introduced in Java 5 and used in GeoTools 2.6, all use of collections > immediately started causing warnings. There has been no campaign to > clean up the code base. > > Try to write clean code and fix things as you go. I use > @SuppressWarnings("serial") liberally and @SuppressWarnings("unchecked") > whenever using unfixed core APIs. Dead code and commented code should be > removed. Nonstatic access to a static member is just bad style and > should be fixed. > > This is what I do, and not official policy. > > The only official policy is to use the Sun coding conventions, with > spaces not tabs, and a wrapping width of 100. The Eclipse formatter.xml > in the repo does this. > > Kind regards, > Ben. > > > On 24/09/10 03:41, Tara Athan wrote: >> I've just been tweaking my development environment, and I was curious >> about the many warnings that Eclipse generates. I have a working set for >> the app-schema module, and with the default settings, Eclipse generates >> over 9000 warnings. About >> 60% of these are connected to generics, >> 35 % to use of deprecated API, >> 4 % unnecessary code, >> 0.5% missing serialVersionUID, >> 0.2% dead code, >> 0.2% non-static access to static member, >> leaving few assorted items of other types. >> >> If I turn off warnings in these categories, then I risk adding to the >> problem (if it is a problem). If I don't turn off the warnings, then >> this view becomes essentially useless because of so many occurrences. >> What, if any, are the geotools conventions about this? >> > > > -- > Ben Caradoc-Davies <[email protected]> > Software Engineering Team Leader > CSIRO Earth Science and Resource Engineering > Australian Resources Research Centre > > ------------------------------------------------------------------------------ > Nokia and AT&T present the 2010 Calling All Innovators-North America contest > Create new apps & games for the Nokia N8 for consumers in U.S. and Canada > $10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing > Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store > http://p.sf.net/sfu/nokia-dev2dev > _______________________________________________ > Geotools-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/geotools-devel > ------------------------------------------------------------------------------ Nokia and AT&T present the 2010 Calling All Innovators-North America contest Create new apps & games for the Nokia N8 for consumers in U.S. and Canada $10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store http://p.sf.net/sfu/nokia-dev2dev _______________________________________________ Geotools-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geotools-devel
