Context Navigation

Editing Nl:DevelopersGuide/StyleGuide

Adjust edit area height: Edit side-by-side

[[TranslatedPages(revision=22)]] 
= Richtlijnen voor ontwikkelen =

== Hoe uw code er uit zou moeten zien ==

* zorg er voor dat de code compatibel is met Java 7
 * zorg er voor dat er geen witruimte achter staat
 * gebruik niet meerdere lege regels achter elkaar
 * JOSM gebruikt 4 tekens voor inspringen en geen tabstops
 * Documenteer uw code '''uitvoerig'''. Veel mensen zullen u daar dankbaar voor zijn :)

== Hoe uw javadoc er uit zou moeten zien ==
 * De [http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide Oracle Javadoc style guide] wordt gebruikt als gids voor de basis
 * {{{@since}}} wordt gebruikt voor publieke klassen en methoden (zichtbaar voor de ontwikkelaars van invoegtoepassingen) met de revisie van JOSM waarin het element werd geïntroduceerd. Voorbeeld: {{{@since 5408}}}
   * {{{@since}}} wordt bijgewerkt als een handtekening van een publieke methode wijzigt of indien een klasse een andere naam krijgt
   * {{{@since}}} kan worden weggelaten voor publieke methoden en velden die tegelijkertijd met de klasse worden geïntroduceerd, vooropgesteld dat zij niet zijn gewijzigd en de klasse juist is gedocumenteerd.
 * {{{@throws}}} heeft de voorkeur boven {{{@exception}}}

=== Eclipse configureren ===
[[Image(wiki:DevelopersGuide/StyleGuide:styleguide_compiler_16.png,700px)]]

[[Image(wiki:DevelopersGuide/StyleGuide:ss1.png,700px)]]

[[Image(wiki:DevelopersGuide/StyleGuide:ss2.png,700px)]]

[[Image(wiki:DevelopersGuide/StyleGuide:ss3.png,700px)]]

== Internationalisatie ==

* zorg er voor dat {{{tr(...)}}} gebruikt voor alle gelocaliseerde tekenreeksen 
   {{{ 
   import import static org.openstreetmap.josm.tools.I18n.tr;

// gebruik tr(...) voor berichten van uitzonderingen
   //
   throw new Exception(tr("foutenbericht altijd in tr()"));

// gebruik tr(...) voor labels, titel, teksten van helptips en soortgelijke 
   //
   new JLabel(tr("Label altijd in tr()"));

// etc.
   }}}

* assembleer gelocaliseerde berichten NOOIT met {{{+}}}. Gebruik in plaats
   daarvan tijdelijke plaatsaanduidingen voor opmaak.

'''NIET'''
   {{{new JLabel(tr("Mijn label " + labelId));}}}

'''MAAR'''
   {{{new JLabel(tr("Mijn label {0}",labelId));}}}
   
   Enige uitzondering: {{{+}}} kan worden gebruikt om lange regels van niet-variabele teksten af te breken.

* Bij het gebruiken van een apostrof, zijn de volgende regels van toepassing:
   
   Voor alle {{{tr}}} is de apostrof speciaal. (Zoals de backslash in C)[[BR]]
   Hij moet worden geëscaped door een andere apostrof:

{{{new JButton(tr("Don''t press me more than {0} times!", n))}}}

Note: See WikiFormatting and TracWiki for help on editing wiki content.

Change information

Your email or username:

E-mail address and name can be saved in the Preferences

Comment about this change (optional):

Note: See TracWiki for help on using the wiki.