wiki:DevelopersGuide/StyleGuide

Version 11 (modified by stoecker, 16 years ago) ( diff )

Name changed from Development_Guidelines to DevelopersGuide/StyleGuide

Development Guidelines

How your code should look like

  • make sure the code is Java 1.5 compatible
    • no @Override for methods for implemented interfaces
  • make sure there is no trailing white space
  • don't use multiple consecutive empty lines
  • Document your code thoroughly. Many people will thank you :)

Configuring Eclipse

No image "ss4.jpg" attached to DevelopersGuide/StyleGuide

Internationalization

  • make sure you use use tr(...) for all localized strings
    import import static org.openstreetmap.josm.tools.I18n.tr;
    
    // use tr(...) for exception messages
    //
    throw new Exception(tr("error message always in tr()"));
    
    // use tr(...) for labels, title, tooltip texts and the like 
    //
    new JLabel(tr("Label always in tr()"));
    
    // etc.
    
  • never assemble localized messages with +. Use format placeholders instead.

DONT new JLabel(tr("My Label " + labelId));

DO new JLabel(tr("My Label {0}",labelId));

Only exception: + can be used to break long lines of non-variable texts.

Attachments (4)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.