Differences between revisions 1 and 2
Revision 1 as of 2005-03-22 05:54:03
Size: 2462
Editor: anonymous
Comment: missing edit-log entry for this revision
Revision 2 as of 2009-09-20 23:52:41
Size: 2464
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
The purpose of this wiki is to document, discuss, and resolve coding conventions for the FOP project. Resolved issues have been or will be moved to [http://xml.apache.org/fop/dev/conventions.html FOP Development: Coding Conventions] on the FOP web site (developer tab). The purpose of this wiki is to document, discuss, and resolve coding conventions for the FOP project. Resolved issues have been or will be moved to [[http://xml.apache.org/fop/dev/conventions.html|FOP Development: Coding Conventions]] on the FOP web site (developer tab).
Line 24: Line 24:
For other FOP-related wiki, see ["FOPProjectPages"]. For other FOP-related wiki, see [[FOPProjectPages]].

Introduction

The purpose of this wiki is to document, discuss, and resolve coding conventions for the FOP project. Resolved issues have been or will be moved to FOP Development: Coding Conventions on the FOP web site (developer tab).

To help keep order and clarity:

  • add your vote to each unresolved issue (only committer votes are binding)
  • sign your comments with your initials
  • use footnotes to comment on other people's entries
  • if necessary, use the SandBox to practice wiki editing!

Contributors

For other FOP-related wiki, see FOPProjectPages.


Resolved Issues

Any items in this section need to be moved to the web site, and removed from this page.


Unresolved Issues

Checkstyle version

Current (at 2003/07/09) version of Eclipse Checkstyle plugin is 3.1.1. Checkstyle is at 3.x. The change to 3.x brought a change in confiuration file format to XML. It seems that most committers who have use Checkstyle in the past were using, and are still using, pre 3.x versions. I suspect that the new versions support more style options, and that after upgrading, we may wish to refine certain options (e.g. the newline on wrap option for opening curly braces.) (pbw)

Thanks, Peter, for raising this issue, as it does need to be documented. The checkstyle plugin for JBuilder is not compatible with checkstyle 3.x. I have assumed that for now our "official" checkstyle is 2.4. Do you (or anyone else) object to documenting it that way? We can have a config file in 3.x that matches our current standards, for those who wish to use 3.x instead. Then, at whatever point our need for 3.x features is strong, we can just switch to that. I am not familiar with the specific refinement you mention. To what specific module and property(s) are you referring? (wvm)

Proposal: Document 2.4 as the checkstyle version used by FOP. (wvm +1)


File encoding of Java source files

Proposal: Only ASCII characters should be used, other characters should be written as unicode escape sequence (\uxxxx) and avoided at all in comments (pij +1) (wvm +1)

FOPDevelopersStyleGuide (last edited 2009-09-20 23:52:41 by localhost)