| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta content="Apache Forrest" name="Generator"> |
| <meta name="Forrest-version" content="0.9-dev"> |
| <meta name="Forrest-skin-name" content="pelt"> |
| <title>Apache Lenya Coding Guidelines</title> |
| <link type="text/css" href="../skin/basic.css" rel="stylesheet"> |
| <link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet"> |
| <link media="print" type="text/css" href="../skin/print.css" rel="stylesheet"> |
| <link type="text/css" href="../skin/profile.css" rel="stylesheet"> |
| <script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script> |
| <link rel="shortcut icon" href="../favicon.ico"> |
| </head> |
| <body onload="init()"> |
| <script type="text/javascript">ndeSetTextSize();</script> |
| <div id="top"> |
| <!--+ |
| |breadtrail |
| +--> |
| <div class="breadtrail"> |
| <a href="http://www.apache.org/">apache</a> > <a href="http://lenya.apache.org/">lenya</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script> |
| </div> |
| <!--+ |
| |header |
| +--> |
| <div class="header"> |
| <!--+ |
| |start group logo |
| +--> |
| <div class="grouplogo"> |
| <a href=""><img class="logoImage" alt="Lenya" src="../images/apache-lenya-light.png" title=""></a> |
| </div> |
| <!--+ |
| |end group logo |
| +--> |
| <!--+ |
| |start Project Logo |
| +--> |
| <div class="projectlogo"> |
| <a href=""></a> |
| </div> |
| <!--+ |
| |end Project Logo |
| +--> |
| <!--+ |
| |start Search |
| +--> |
| <div class="searchbox"> |
| <form action="http://www.google.com/search" method="get" class="roundtopsmall"> |
| <input value="lenya.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with ');" size="25" name="q" id="query" type="text" value="Search the site with "> |
| <input name="Search" value="Search" type="submit"> |
| </form> |
| </div> |
| <!--+ |
| |end search |
| +--> |
| <!--+ |
| |start Tabs |
| +--> |
| <ul id="tabs"> |
| <li> |
| <a class="unselected" href="../index.html">Project</a> |
| </li> |
| <li class="current"> |
| <a class="selected" href="../docs/index.html">Developer</a> |
| </li> |
| <li> |
| <a class="unselected" href="../community/index.html">Community</a> |
| </li> |
| <li> |
| <a class="unselected" href="../docs/2_0_x/index.html">Version 2.0</a> |
| </li> |
| <li> |
| <a class="unselected" href="../docs/1_2_x/index.html">Version 1.2</a> |
| </li> |
| </ul> |
| <!--+ |
| |end Tabs |
| +--> |
| </div> |
| </div> |
| <div id="main"> |
| <div id="publishedStrip"> |
| <!--+ |
| |start Subtabs |
| +--> |
| <div id="level2tabs"></div> |
| <!--+ |
| |end Endtabs |
| +--> |
| <script type="text/javascript"><!-- |
| document.write("Last Published: " + document.lastModified); |
| // --></script> |
| </div> |
| <!--+ |
| |breadtrail |
| +--> |
| <div class="breadtrail"> |
| |
| |
| </div> |
| <!--+ |
| |start Menu, mainarea |
| +--> |
| <!--+ |
| |start Menu |
| +--> |
| <div id="menu"> |
| <div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Developer</div> |
| <div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> |
| <div class="menuitem"> |
| <a href="../docs/index.html">Index</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://svn.apache.org/viewcvs.cgi/lenya/#dirlist">SVN Web</a> |
| </div> |
| <div class="menupage"> |
| <div class="menupagetitle">Coding Guidelines</div> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs/website-update.html">Website Update</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs/release.html">Release Management</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs/zone.html">Zone notes</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs/resolution.html">Resolution</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs/charter.html">Charter</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs/guidelines.html">Project guidelines</a> |
| </div> |
| </div> |
| <div id="credit"></div> |
| <div id="roundbottom"> |
| <img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div> |
| <!--+ |
| |alternative credits |
| +--> |
| <div id="credit2"> |
| <a href="http://wiki.apache.org/lenya/MeetingFreiburg2008"><img border="0" title="Meeting Freiburg 2008" alt="Meeting Freiburg 2008 - logo" src="../images/apache-lenya-meeting-freiburg-2008.png" style="width: 160px;height: 40px;"></a> |
| </div> |
| </div> |
| <!--+ |
| |end Menu |
| +--> |
| <!--+ |
| |start content |
| +--> |
| <div id="content"> |
| <div title="Portable Document Format" class="pdflink"> |
| <a class="dida" href="coding-guidelines.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br> |
| PDF</a> |
| </div> |
| <h1>Apache Lenya Coding Guidelines</h1> |
| <div id="front-matter"> |
| <div id="minitoc-area"> |
| <ul class="minitoc"> |
| <li> |
| <a href="#Introduction">Introduction</a> |
| </li> |
| <li> |
| <a href="#Java+Code">Java Code</a> |
| </li> |
| <li> |
| <a href="#XML+and+XSP">XML and XSP</a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| <a name="N1000E"></a><a name="Introduction"></a> |
| <h2 class="h3">Introduction</h2> |
| <div class="section"> |
| <p> |
| We use coding standards so that Lenya source code is easy to |
| understand, to maintain, and to enhance. |
| </p> |
| <p> |
| We are using the commit-then-review approach. |
| Still, <strong>nothing</strong> untested should be |
| committed. First test then commit!!! |
| </p> |
| </div> |
| |
| <a name="N1001E"></a><a name="Java+Code"></a> |
| <h2 class="h3">Java Code</h2> |
| <div class="section"> |
| <p> |
| Generally we stick with standards. In the case of coding |
| standards we simply use the guidelines from Sun. |
| </p> |
| <p> |
| Here are the rules: |
| </p> |
| <ul> |
| |
| <li>Thou shalt only produce code conforming to the Java code |
| conventions, as they are set down on the page <a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html</a> |
| |
| <p></p> |
| |
| </li> |
| |
| <li>Thou shalt not produce any code containing tab-stops. |
| <p></p> |
| |
| </li> |
| |
| </ul> |
| </div> |
| |
| <a name="N1003C"></a><a name="XML+and+XSP"></a> |
| <h2 class="h3">XML and XSP</h2> |
| <div class="section"> |
| <p> |
| The only restriction we impose on XML, XSLT and XSP code is |
| that the indenting is 2 spaces. Again please no tab stops. |
| </p> |
| </div> |
| |
| </div> |
| <!--+ |
| |end content |
| +--> |
| <div class="clearboth"> </div> |
| </div> |
| <div id="footer"> |
| <!--+ |
| |start bottomstrip |
| +--> |
| <div class="lastmodified"> |
| <script type="text/javascript"><!-- |
| document.write("Last Published: " + document.lastModified); |
| // --></script> |
| </div> |
| <div class="copyright"> |
| Copyright © |
| 2002-2007 <a href="http://www.apache.org/licenses/LICENSE-2.0">The Apache Software Foundation.</a> |
| </div> |
| <div id="feedback"> |
| Send feedback about the website to: |
| <a id="feedbackto" href="mailto:dev@lenya.apache.org?subject=Feedback%C2%A0for%C2%A0docs/coding-guidelines.html">dev@lenya.apache.org</a> |
| </div> |
| <!--+ |
| |end bottomstrip |
| +--> |
| </div> |
| </body> |
| </html> |
