Index: docs/site/code-standards.html =================================================================== RCS file: /home/cvspublic/jakarta-jetspeed/docs/site/code-standards.html,v retrieving revision 1.35 diff -u -r1.35 code-standards.html --- code-standards.html 1 Aug 2003 20:58:10 -0000 1.35 +++ code-standards.html 25 Aug 2003 08:19:27 -0000 @@ -130,7 +130,7 @@
+
- Use javadoc on all methods. @@ -179,7 +179,7 @@
+A Java style checker, checkStyle, is part of the build process. This should aid in the development of readable code. Jetspeed currently works with version 2.4 of @@ -244,7 +244,7 @@
+
Use of brackets. Some developers have personal a preference to how they place brackets within their source code:
@@ -281,11 +281,11 @@ -+
Please choose whatever style you want for new files but you should maintain the existing style of source you wish to modify.
-+
If you have a method with multiple parameters, separate them across multiple lines.
@@ -339,8 +339,8 @@-- Testing is a great way to detect and prevent bug. By automating the +
+ Testing is a great way to detect and prevent bugs. By automating the testing process, the test are easy to run and identify failures. Jetspeed uses the testing facilities built into Ant, primarily Cactus and JUnit. @@ -352,7 +352,7 @@
+
- The name of test class should start with
Testand be @@ -389,7 +389,7 @@
Required Tests -+
The required tests are made up of Cactus and JUnit test used to insure working, and hopefully bug free, code.
@@ -445,7 +445,7 @@
Unit Test Groups -+
These are unit tests grouped logically. In some case their is a testing hierarchy. In the case of unittest-security. It is composed of the security implementation test, i.e. unittest-security-registry @@ -515,7 +515,7 @@
+Cactus testing is used when rundata is required. The test usually involve generating a URL in beginTestName(). The URL is @@ -546,7 +546,7 @@
+JUnit testing is simpler the Cactus testing, in part because the do not require a web server. These test generally test small functional @@ -585,7 +585,7 @@
+Enter the property in the language propery file,
org.apache.jetspeed.modules.localization.JetspeedProperty_@@ -629,7 +629,7 @@
+The following code will place the localized, based on the user's language, value into the variable
title. @@ -669,7 +669,7 @@
-+
The following code will center the localized, based on the user's language, value on the resulting portlet.
@@ -710,7 +710,7 @@
+Logging is very useful for diagnosing and resolving problems. As a general rule, all exceptions should be logged, and done so in the following fashion:
@@ -762,7 +762,7 @@
+
The following code snippet shows how to use the new logging features.
+
- File structuring. Try to keep everything organized according to the @@ -849,7 +849,7 @@
+All changes posted by non-committers should be submitted (and accepted) in form of patches. Patches can be created from root of the project using the this command: