| | 1 | [[TranslatedPages(revision=21)]] |
| | 2 | = Richtlijnen voor ontwikkelen = |
| | 3 | |
| | 4 | == Hoe uw code er uit zou moeten zien == |
| | 5 | |
| | 6 | * zorg er voor dat de code compatibel is met Java 1.6 |
| | 7 | * zorg er voor dat er geen witruimte achter staat |
| | 8 | * gebruik niet meerdere lege regels achter elkaar |
| | 9 | * JOSM gebruikt 4 tekens voor inspringen en geen tabstops |
| | 10 | * Documenteer uw code '''uitvoerig'''. Veel mensen zullen u daar dankbaar voor zijn :) |
| | 11 | |
| | 12 | == Hoe uw javadoc er uit zou moeten zien == |
| | 13 | * De [http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide Oracle Javadoc style guide] wordt gebruikt als gids voor de basis |
| | 14 | * {{{@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}}} |
| | 15 | * {{{@since}}} wordt bijgewerkt als een handtekening van een publieke methode wijzigt of indien een klasse een andere naam krijgt |
| | 16 | * {{{@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. |
| | 17 | * {{{@throws}}} heeft de voorkeur boven {{{@exception}}} |
| | 18 | |
| | 19 | === Eclipse configuren === |
| | 20 | [[Image(styleguide_compiler_16.png,700px)]] |
| | 21 | |
| | 22 | [[Image(ss1.png,700px)]] |
| | 23 | |
| | 24 | [[Image(ss2.png,700px)]] |
| | 25 | |
| | 26 | [[Image(ss3.png,700px)]] |
| | 27 | |
| | 28 | |
| | 29 | == Internationalisatie == |
| | 30 | |
| | 31 | * zorg er voor dat {{{tr(...)}}} gebruikt voor alle gelocaliseerde tekenreeksen |
| | 32 | {{{ |
| | 33 | import import static org.openstreetmap.josm.tools.I18n.tr; |
| | 34 | |
| | 35 | // gebruik tr(...) voor berichten van uitzonderingen |
| | 36 | // |
| | 37 | throw new Exception(tr("foutenbericht altijd in tr()")); |
| | 38 | |
| | 39 | // gebruik tr(...) voor labels, titel, teksten van helptips en soortgelijke |
| | 40 | // |
| | 41 | new JLabel(tr("Label altijd in tr()")); |
| | 42 | |
| | 43 | // etc. |
| | 44 | }}} |
| | 45 | |
| | 46 | |
| | 47 | * assembleer gelocaliseerde berichten NOOIT met {{{+}}}. Gebruik in plaats |
| | 48 | daarvan tijdelijke plaatsaanduidingen voor opmaak. |
| | 49 | |
| | 50 | '''NIET''' |
| | 51 | {{{new JLabel(tr("Mijn label " + labelId));}}} |
| | 52 | |
| | 53 | |
| | 54 | '''MAAR''' |
| | 55 | {{{new JLabel(tr("Mijn label {0}",labelId));}}} |
| | 56 | |
| | 57 | Enige uitzondering: {{{+}}} kan worden gebruikt om lange regels van niet-variabele teksten af te breken. |
| | 58 | |
| | 59 | * Bij het gebruiken van een apostrof, zijn de volgende regels van toepassing: |
| | 60 | |
| | 61 | Voor alle {{{tr}}} is de apostrof speciaal. (Zoals de backslash in C)[[BR]] |
| | 62 | Hij moet worden geëscaped door een andere apostrof: |
| | 63 | |
| | 64 | {{{new JButton(tr("Don''t press me more than {0} times!", n))}}} |
