Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Httpcomponents Wiki" 
for change notification.

The "CodingConventions" page has been changed by TonyPoppleton.
http://wiki.apache.org/HttpComponents/CodingConventions?action=diff&rev1=7&rev2=8

--------------------------------------------------

   * {3} Never simply print an exception to stderr or stdout, as the exception 
will effectively just be lost.
   * {3} In very rare cases it may be approriate to ignore an exception, in 
which case document it clearly.
   * {3} TODO is there a custom HTTP client exception that is used?
+  * {3} Always try and add a useful message to the exception in case any one 
encounters it, containing for example any runtime data that can be used to 
diagnose the exception
   * {3} Handle exceptional conditions by throwing an exception and not, for 
example, returning null from a method.
   * {3} Checked exceptions should represent potentially recoverable 
exceptions; runtime exceptions should represent non-recoverable errors / 
unexpected errors / programming errors, as per 
[http://www.oracle.com/technology/pub/articles/dev2arch/2006/11/effective-exceptions.html].
  
@@ -69, +70 @@

   * {3} For situations that do require synchronisation, use classes from the 
Concurrent API if possible.  Vector is not enough on its own as the following 
link explains [http://www.ibm.com/developerworks/java/library/j-jtp09263.html]
  
  == JIRA integration ==
-  * {3} Comment a block of code with the JIRA reference if appropriate 
(especially for bug fixes), for example #HTTPCLIENT-1
+  * {3} Comment a block of code with the JIRA reference if appropriate 
(especially for bug fixes), for example HTTPCLIENT-1
   * {3} When committing a patch, add the JIRA reference in the commit comment 
(JIRA can then list the file under the "Subversion Commits" tab)
  
  == General ==

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to