226 lines
7.0 KiB
HTML
226 lines
7.0 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
|
|
<title>POI Resoluton</title>
|
||
|
|
</head>
|
||
|
|
<body bgcolor="#ffffff" marginheight="4" marginwidth="4" leftmargin="4" topmargin="4" alink="#023264" vlink="#023264" link="#525D76" text="#000000">
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><a href="http://jakarta.apache.org/index.html"><img src="images/jakarta-logo.gif" border="0" vspace="0" hspace="0"></a></td><td bgcolor="#ffffff" align="left" valign="top" width="100%"><img src="images/header.gif" align="right" border="0" vspace="0" hspace="0"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td colspan="2" height="2" width="100%">
|
||
|
|
<hr size="1" noshade="">
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||
|
|
<tr>
|
||
|
|
<td valign="top" width="1%"></td><td nowrap="1" valign="top" width="14%">
|
||
|
|
<br>
|
||
|
|
<font face="arial,helvetica,sanserif">
|
||
|
|
<br>
|
||
|
|
<font size="+1" color="#000000">Navigation</font><font size="-1">
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<a href="../index.html"><font size="-1">Main</font></a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</font>
|
||
|
|
<br>
|
||
|
|
<font size="+1" color="#000000">About</font><font size="-1">
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<a href="index.html"><font size="-1">About</font></a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</font>
|
||
|
|
<br>
|
||
|
|
<font size="+1" color="#000000">Resolutions</font><font size="-1">
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<a href="res001.html"><font size="-1">Coding Standards</font></a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</font>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
</font></td><td align="left" valign="top" width="*">
|
||
|
|
<title>POI Resoluton</title>
|
||
|
|
<center>
|
||
|
|
<table width="80%">
|
||
|
|
<tr>
|
||
|
|
<td bgcolor="#F3DD61"><font face="Arial,sans-serif" size="+1">
|
||
|
|
<center>
|
||
|
|
<b>POI Resoluton</b>
|
||
|
|
</center>
|
||
|
|
</font></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
<font size="-2" color="#000000">
|
||
|
|
<p>
|
||
|
|
<a href="mailto:"></a>
|
||
|
|
</p>
|
||
|
|
</font>
|
||
|
|
<br>
|
||
|
|
<div align="right">
|
||
|
|
<table cellspacing="0" cellpadding="2" border="0" width="100%">
|
||
|
|
<tr>
|
||
|
|
<td bgcolor="#525D76"><font color="#ffffff" size="+1"><font face="Arial,sans-serif"><b>Resolution 001 - Minimal Coding Standards</b></font></font></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<div align="right">
|
||
|
|
<table cellspacing="0" cellpadding="2" border="0" width="99%">
|
||
|
|
<tr>
|
||
|
|
<td bgcolor="#525D76"><font color="#ffffff" size="+0"><font face="Arial,sans-serif"><b>Majority Position</b></font></font></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<p align="justify">
|
||
|
|
As the POI project has grown the "styles" used have become more
|
||
|
|
varied, some see this as a bad thing, but in reality it
|
||
|
|
can be a good thing. Each can learn from the different
|
||
|
|
styles by working with different code. That being said
|
||
|
|
there are some universal "good quality" guidelines that
|
||
|
|
must be adopted on a project of any proportions.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p align="justify">
|
||
|
|
Marc Johnson Authored the following resolution:
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p align="justify">
|
||
|
|
On Tue, 2002-01-08 at 22:23, Marc Johnson wrote:
|
||
|
|
Standards are wonderful; everyone should have a set.
|
||
|
|
Here's what I propose for coding standards for POI WRT comments (should I
|
||
|
|
feel the need, I'll post more of these little gems):
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
All classes and interfaces MUST have, right at the beginning, the POI
|
||
|
|
License (see poi/doc/LICENSE).
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
All classes and interfaces MUST include class javadoc. Conventionally,
|
||
|
|
this goes after the package and imports, and before the start of the class
|
||
|
|
or interface. The class javadoc MUST have at least one @author tag
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
All methods that are accessible outside the class MUST have javadoc
|
||
|
|
comments. In other words, if it isn't private, it MUST have javadoc
|
||
|
|
comments. Simple getters can consist of a simple @return tag; simple setters
|
||
|
|
can consist of a simple @param tag. Anything else requires some verbiage
|
||
|
|
plus all the standard javadoc tags as appropriate. You MUST include @throws
|
||
|
|
or @exception for any non-runtime exceptions, and you SHOULD document any
|
||
|
|
runtime exceptions you expect to throw. @throws/@exception tags SHOULD
|
||
|
|
include an explanation of why that exception would be thrown. If your method
|
||
|
|
might return null, you MUST say so. An accompanying explanation of the
|
||
|
|
circumstances for doing so would be nice.
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<div align="right">
|
||
|
|
<table cellspacing="0" cellpadding="2" border="0" width="99%">
|
||
|
|
<tr>
|
||
|
|
<td bgcolor="#525D76"><font color="#ffffff" size="+0"><font face="Arial,sans-serif"><b>Amendments (informal by extension and not by vote)</b></font></font></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<p align="justify">
|
||
|
|
As opposed to the formerly used POI License which was
|
||
|
|
based on the Apache Public License, now that POI is part of
|
||
|
|
Jakarta, use the APL 1.1 for the header. Currently, the
|
||
|
|
Apache Software Foundation requires us to use the full
|
||
|
|
long version.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<div align="right">
|
||
|
|
<table cellspacing="0" cellpadding="2" border="0" width="99%">
|
||
|
|
<tr>
|
||
|
|
<td bgcolor="#525D76"><font color="#ffffff" size="+0"><font face="Arial,sans-serif"><b>Dissent</b></font></font></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<p align="justify">
|
||
|
|
The motion was passed unanimously with no negative or
|
||
|
|
positive votes.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<div align="right">
|
||
|
|
<table cellspacing="0" cellpadding="2" border="0" width="99%">
|
||
|
|
<tr>
|
||
|
|
<td bgcolor="#525D76"><font color="#ffffff" size="+0"><font face="Arial,sans-serif"><b>Comments</b></font></font></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<p align="justify">
|
||
|
|
Andy didn't feel like going through his mail and sucking
|
||
|
|
out the comments.. If there is anything you feel should
|
||
|
|
be added here do it yourself ;-).
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0" width="100%">
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<hr size="1" noshade="">
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="center"><font color="#525D76" size="-1" face="arial,helvetica,sanserif"><i>
|
||
|
|
Copyright ©2002 Apache Software Foundation
|
||
|
|
</i></font></td><td width="5%" align="right"><img src="images/cocoon2-small.jpg" align="right" border="0" vspace="0" hspace="0"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|