From: William Victor Mote <vmote@apache.org>
Date: Tue, 1 Jul 2003 18:40:26 +0000 (+0000)
Subject: Move some of the resolved "style" wiki contents to conventions.xml.
X-Git-Tag: Root_Temp_KnuthStylePageBreaking~1366
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=4412935e117e0676296a7895e767c73edbcad3a3;p=xmlgraphics-fop.git

Move some of the resolved "style" wiki contents to conventions.xml.


git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196556 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/documentation/content/xdocs/dev/conventions.xml b/src/documentation/content/xdocs/dev/conventions.xml
index c6a376e2b..320efbc47 100644
--- a/src/documentation/content/xdocs/dev/conventions.xml
+++ b/src/documentation/content/xdocs/dev/conventions.xml
@@ -12,26 +12,84 @@
         <title>Java Style</title>
         <p>In order to facilitate the human reading of FOP source code, the FOP developers have agreed on a set of coding conventions.
 The basis of these coding conventions is documented in the <link href="http://xml.apache.org/source.html">Apache XML Project Guidelines</link>, which requires that <strong>all Java Language source code in the repository must be written in conformance to Sun's</strong> <link href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Code Conventions for the Java Programming Language</link>.
-In addition, other conventions have been applied to the FOP project, which are summarized in the following table:</p>
+In addition, the FOP developers have agreed to other conventions, which are summarized in the following table:</p>
         <table>
           <tr>
             <th>Convention</th>
             <th>Rationale</th>
             <th>Enforced By</th>
           </tr>
+          <tr>
+            <td>Every Java source file starts with the Apache licence header.</td>
+            <td>Required by Apache.</td>
+            <td>checkstyle</td>
+          </tr>
           <tr>
             <td>No tabs in content</td>
             <td>Programmers should not have to adjust the tab settings in their editor to be able to read the source code.</td>
             <td>checkstyle</td>
           </tr>
           <tr>
-            <th>Indentation of 4 spaces per level</th>
-            <th>Maximize readability.</th>
-            <th>Not enforced</th>
+            <td>Indentation of 4 spaces per level</td>
+            <td>Maximize readability.</td>
+            <td>Not enforced</td>
+          </tr>
+          <tr>
+            <td>Comments must be in English</td>
+            <td>To avoid the need for everyone to learn all languages, English has become the standard language for many technology projects, and is the only human language that all FOP developers are expected to know.</td>
+            <td>Not enforced</td>
+          </tr>
+          <tr>
+            <td>Fully qualify all import statements (no "import java.util.*")</td>
+            <td>Clarity</td>
+            <td>checkstyle</td>
+          </tr>
+          <tr>
+            <td>No underscores in variable names except for static finals.</td>
+            <td>Upper/lower case distinctions can be made in all other variable names, eliminating the need for artificial word boundaries.</td>
+            <td>checkstyle</td>
+          </tr>
+          <tr>
+            <td>Opening brace for a block should be on the same line as its control statement (if, while, etc.).</td>
+            <td>Standardization, general preference.</td>
+            <td>checkstyle</td>
           </tr>
         </table>
         <p>For developers that dislike these conventions, one workaround is to develop using their own style, then use a formatting tool like <link href="http://astyle.sourceforge.net/">astyle</link> (Artistic Style) before committing.</p>
       </section>
+      <section id="java-checkstyle">
+        <title>Checkstyle</title>
+        <p>The java syntax checker "<jump href="http://checkstyle.sourceforge.net">Checkstyle</jump>" is used to enforce many of the FOP coding standards.
+The standards enforced through Checkstyle are documented in its configuration file (xml-fop/checkstyle.cfg).
+The conventions defined in the configuration file are an integral part of FOP's coding conventions, and should not be changed without common consent.
+In other words, the configuration file contains additional conventions that are not documented on this page, but are generally accepted as good style within the java community (i.e. they are the default behavior of checkstyle, which the FOP developers have decided to adopt <em>de facto</em>).
+Any apparent contradiction between the configuration file and this document should be raised on the fop-dev mailing list so that it can be clarified.</p>
+        <p>To use the "checkstyle" target in FOP's build process, download the source from the <jump href="http://checkstyle.sourceforge.net">Checkstyle web site</jump>, place checkstyle-all-*.jar in the lib directory and call "build checkstyle". Output (in the build directory) includes checkstyle_report.txt and checkstyle_report.xml. If you copy the file contrib/checkstyle-noframes.xsl from Checkstyle into FOP's root directory, you will also get an HTML report.</p>
+        <p>Checkstyle is probably most useful when integrated into your IDE. See the Checkstyle web site for more information about IDE plugins.</p>
+      </section>
+      <section id="java-best-practices">
+        <title>Java Best Practices</title>
+        <p>The following general principles are a distillation of best practice expectations on the FOP project.</p>
+        <ul>
+          <li>Apply common sense when coding. When coding keep in mind that others will read your code and have to understand it.</li>
+          <li>Readability comes before performance, at least initially.</li>
+          <li>If you can refactor some code to make it more understandable, please do so.</li>
+          <li>Properly document code, especially where it's important.</li>
+          <li>Use interfaces instead of implementations where possible.
+This favors a clearer design and makes switching between implementations easier (Examples: List instead of ArrayList/Vector, Map instead of HashMap/Hashtable).</li>
+
+
+          <li>Avoid using exceptions for flow control.</li>
+          <li>Try to catch exceptions as much as possible and rethrow higher level exceptions (meaning hiding the low level detailed and putting a message that is more related to the function of your code).</li> 
+          <li>It is important not to lose the stack trace which contains important information.
+Use chained exception for that. Avalon Framework provides [CascadingException] (and similar) for this.
+Exception class names and stack traces must be treated like gold.
+Do whatever is required so that this information is not lost.
+Printing error messages to System.err or System.out is useless in a server-side environment where this info is usually lost.</li>
+          <li>Always log the exception at the higher level (i.e. where it is handled and not rethrown).</li> 
+          <li>Try to avoid catching Throwable or Exception and catch specific exceptions instead.</li>
+        </ul>
+      </section>
     </section>
   </body>
 </document>