FOP Development: Coding Conventions

Date: Mon, 7 Jul 2003 18:59:46 +0000 (+0000) Subject: Move remaing resolved issues (to date) from the wiki. X-Git-Tag: Root_Temp_KnuthStylePageBreaking~1318 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=58262b735692324417528781890405272de5b4f9;p=xmlgraphics-fop.git Move remaing resolved issues (to date) from the wiki. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196636 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/documentation/content/xdocs/dev/conventions.xml b/src/documentation/content/xdocs/dev/conventions.xml index 658a2e629..cdc351ea1 100644 --- a/src/documentation/content/xdocs/dev/conventions.xml +++ b/src/documentation/content/xdocs/dev/conventions.xml @@ -6,6 +6,15 @@ FOP Development: Coding Conventions +

Acknowledgement: Some content in this guide was adapted from other Apache projects such as Avalon, Cactus, Turbine and Velocity.

+ CVS Repository +

Conventions in this section apply to Repository content, regardless of type:

Files checked in must conform to the code conventions for that type of file (java files must conform to java requirements, xml to xml requirements, etc.). If a submitted patch does not conform, it is the responsibility of the committer to bring it into conformance before checking it in. Developers submitting patches are encouraged to follow the code conventions to reduce the work load on the the committers.
To reduce the amount of spurious deltas, all text (non-binary) files checked into CVS must have Unix-style line endings (LF only). Many IDEs and editors (even on non-Unix platforms) have settings that can facilitate this convention.

Java

@@ -54,6 +63,11 @@ In addition, the FOP developers have agreed to other conventions, which are summ Standardization, general preference. checkstyle + + Write appropriate javadoc entries for all public and protected classes, methods, and variables. + Basic API documentation is needed. + checkstyle +

For developers that dislike these conventions, one workaround is to develop using their own style, then use a formatting tool like astyle (Artistic Style) before committing.

@@ -90,6 +104,46 @@ Printing error messages to System.err or System.out is useless in a server-side

Try to avoid catching Throwable or Exception and catch specific exceptions instead.

+ Resources +

[book on code style] Code Complete by Steve McConnell.
[code formatting software] JRefactory.

+ Related Links +

Apache Source Repositories
Jakarta Code Conventions and Standards (see Coding Conventions and Standards section)
Avalon Project - Coding Standards

+ +

+ XML + + + + + + + + + + + + + + + + + + + + + +

Convention	Rationale	Enforced By
XML files must always be well-formed. Validation is optional.	Document integrity	Not enforced
No tabs in content.	Users should not have to adjust tab settings in their editor to be able to read the content.	Not enforced
Indentation of 2 spaces per level	Maximize readability	Not enforced