commit-classpath
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Patch: FYI: more standards updates


From: Tom Tromey
Subject: Patch: FYI: more standards updates
Date: 09 Jan 2004 13:46:24 -0700
User-agent: Gnus/5.09 (Gnus v5.9.0) Emacs/21.3.50

I'm checking this in.

I believe these new guidelines also reflect current consensus.  If you
disagree, we can discuss on the main list.

Tom

Index: ChangeLog
from  Tom Tromey  <address@hidden>

        * doc/hacking.texinfo (Programming Standards): Added some more
        standards.

Index: doc/hacking.texinfo
===================================================================
RCS file: /cvsroot/classpath/classpath/doc/hacking.texinfo,v
retrieving revision 1.14
diff -u -r1.14 hacking.texinfo
--- doc/hacking.texinfo 9 Jan 2004 00:34:16 -0000 1.14
+++ doc/hacking.texinfo 9 Jan 2004 20:52:47 -0000
@@ -385,6 +385,24 @@
   return foo.doit();
 @end example
 
address@hidden
+Don't use redundant modifiers.  For instance, all members of an
+interface are implicitly @code{public}, so there is no need to
+explicitly declare them as @code{public}.
+
address@hidden
+Because the output of different compilers differs, we have
+standardized on explicitly specifying @code{serialVersionUID} in
address@hidden classes in Classpath.  This field should be
+declared as @code{private static final}.
address@hidden fixme index
address@hidden fixme link to the discussion
+
address@hidden
+Don't declare unchecked exceptions in the @code{throws} clause of a
+method.  However, if throwing an unchecked exception is part of the
+method's API, you should mention it in the Javadoc.
+
 @end itemize
 
 




reply via email to

[Prev in Thread] Current Thread [Next in Thread]